[r9874]: docs / trunk / oodialog / en-US / statusBar.xml Maximize Restore History

Download this file

statusBar.xml    1543 lines (1459 with data), 54.4 kB

   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
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference XML file.
#
# Copyright (c) 2013-2014 Rexx Language Association. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<chapter id="clsStatusBar" xreflabel="StatusBar"><title>StatusBar Controls</title>
<indexterm><primary>StatusBar class</primary></indexterm>
<para>
A status bar is a horizontal window at the bottom of a dialog that the programmer can use to display status information
about the application. Status bars can be divided into more than one part to display different types of status information.
Status bars set their initial size and position automatically, ignoring any co-ordinates the programmer may have specified.
By default they position themselves at the bottom edge of the dialog with a width as wide as the dialog and a height that
is calculated based on the metrics for the font of the dialog.
</para>
<para>
Unlike other dialog controls, many resource editors do not have built-in supprort for status bars. However it is easy to
manually edit the .rc file and add a status bar. One technique is to add another control, say a combo box control, save the
.rc file and then edit the combo box control definition in the .rc file to make it a status bar.
</para>
<para>
As an example of this, the following listing shows part of a .rc file with a combo box, that is intended to be edited to
change it to a status bar;
<programlisting>
<![CDATA[
LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
IDD_DLL_TEST DIALOGEX 0, 0, 227, 114
STYLE DS_3DLOOK | DS_CENTER | DS_MODALFRAME | DS_SHELLFONT | WS_CAPTION | WS_VISIBLE | WS_POPUP | WS_SYSMENU
CAPTION "DLL Dialog"
FONT 8, "Ms Shell Dlg", 400, 0, 1
{
CONTROL "", IDC_CB, WC_COMBOBOX, WS_TABSTOP | NOT WS_VISIBLE | CBS_DROPDOWN | CBS_HASSTRINGS, 10, 33, 47, 12
CONTROL "", IDC_EDIT, WC_EDIT, NOT WS_BORDER | WS_TABSTOP | NOT WS_VISIBLE | ES_AUTOHSCROLL, 10, 55, 59, 12
CONTROL "Test", IDC_PB_TEST, WC_BUTTON, WS_TABSTOP | BS_PUSHBUTTON | BS_SPLITBUTTON, 10, 72, 70, 18
CONTROL "OK", IDOK, WC_BUTTON, WS_TABSTOP | BS_DEFPUSHBUTTON, 112, 72, 50, 14
CONTROL "Cancel", IDCANCEL, WC_BUTTON, WS_TABSTOP | BS_PUSHBUTTON, 167, 72, 50, 14
}
]]>
</programlisting>
Once the template is started as above, it is a simple matter to replace the IDE_CB line with the proper values for a status
bar as below:
<programlisting>
<![CDATA[
LANGUAGE LANG_NEUTRAL, SUBLANG_NEUTRAL
IDD_DLL_TEST DIALOGEX 0, 0, 227, 114
STYLE DS_3DLOOK | DS_CENTER | DS_MODALFRAME | DS_SHELLFONT | WS_CAPTION | WS_VISIBLE | WS_POPUP | WS_SYSMENU
CAPTION "DLL Dialog"
FONT 8, "Ms Shell Dlg", 400, 0, 1
{
CONTROL "", IDC_STATUSBAR, STATUSCLASSNAME, SBARS_TOOLTIPS, 0, 1, 227, 21
CONTROL "", IDC_EDIT, WC_EDIT, NOT WS_BORDER | WS_TABSTOP | NOT WS_VISIBLE | ES_AUTOHSCROLL, 10, 55, 59, 12
CONTROL "Test", IDC_PB_TEST, WC_BUTTON, WS_TABSTOP | BS_PUSHBUTTON | BS_SPLITBUTTON, 10, 72, 70, 18
CONTROL "OK", IDOK, WC_BUTTON, WS_TABSTOP | BS_DEFPUSHBUTTON, 112, 72, 50, 14
CONTROL "Cancel", IDCANCEL, WC_BUTTON, WS_TABSTOP | BS_PUSHBUTTON, 167, 72, 50, 14
}
]]>
</programlisting>
As noted, the status bar will ignore the size and position co-ordinate, so any 4 values will sufffice. This technique will
work for the ooDialog programmer wishing to ust a status bar in their <xref linkend="clsRcDialog"/> or <xref
linkend="clsResDialog"/> dialogs.
</para>
<para>
The other good option for adding status bars to <computeroutput>RcDialog</computeroutput> or
<computeroutput>ResDialog</computeroutput> dialogs is to use the <xref linkend="mthCreateStatusBarWindow"/> method of the
<xref linkend="clsCreateWindows"/> class.
</para>
<para>
The <computeroutput>StatusBar</computeroutput> class provides methods to work with and manipulate the underlying Windows
status bar dialog control which it represents. It is a concrete subclass of the dialog <xref
linkend="chpDialogControlObject"/> object and therefore has all methods of the dialog control object.
</para>
<para>
In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are
needed, or are useful, when working with status bar controls:
<variablelist>
<varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term>
<listitem>
<para>
Use the <xref linkend="tmthNewStatusBar"/> method of the <xref linkend="chpDialogObject"/> object to retrieve a new
StatusBar object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term>
<listitem>
<para>
To dynamically define a status bar in a <xref linkend="clsUserDialog"/> class, use the <xref
linkend="tmthCreateStatusBar"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Notification</emphasis></term>
<listitem>
<para>
To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying status bar control to
a method in the Rexx dialog object use the <xref linkend="tmthConnectStatusBarEvent"/> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Window Creation:</emphasis></term>
<listitem>
<para>
To dynamically create a status bar window in a dialog, use the <xref linkend="tmthCreateStatusBarWindow"/> method. This
can only be done after the underlying Windows dialog has been created.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<section id="sctMethodsStatustBar"><title>Method Table</title>
<para>
The following table provides links to the documentation for the primary classes, methods, and attributes used in working
with StatusBar objects, including the pertinent classes, and methods from other classes:
</para>
<table id="tblStatusBarMethods" frame="all">
<title>Important StatusBar Methods</title>
<tgroup cols="2">
<colspec colwidth="2*" />
<colspec colwidth="5*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Useful</emphasis></entry>
<entry align="center"><emphasis role="bold"> External Methods</emphasis></entry>
</row>
<row>
<entry><xref linkend="tmthNewStatusBar"/></entry>
<entry>Returns a Rexx <computeroutput>StatusBar</computeroutput> object for the control with the specified ID.</entry>
</row>
<row>
<entry><xref linkend="tmthCreateStatusBar"/></entry>
<entry>Creates a status bar control in the dialog template of a <xref linkend="clsUserDialog"/>.</entry>
</row>
<row>
<entry><xref linkend="tmthCreateStatusBarWindow"/></entry>
<entry>Creates a status bar control in an existing Windows dialog.</entry>
</row>
<row>
<entry><xref linkend="tmthConnectStatusBarEvent"/></entry>
<entry>Connects status bar event notifications to a method in the Rexx dialog object</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthGetBorders"/></entry>
<entry>Returns an array of three integers containing the borders of the status bar.</entry>
</row>
<row>
<entry><xref linkend="mthGetIconClsStatusBar"/></entry>
<entry>Retrieves the icon image for the specified part.</entry>
</row>
<row>
<entry><xref linkend="mthGetParts"/></entry>
<entry>Returns the number of parts in the status bar, and optionally, the co-ordinate of the right edge of each part.</entry>
</row>
<row>
<entry><xref linkend="mthGetRectClsStatusBar"/></entry>
<entry>Returns a <xref linkend="clsRect"/> object that contains the bounding rectangle of the specified part in this status bar.</entry>
</row>
<row>
<entry><xref linkend="mthGetTextClsStatusBar"/></entry>
<entry>Retrieves the text of the specified part and optionally some extra information related to the part.</entry>
</row>
<row>
<entry><xref linkend="mthGetTextLength"/></entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthGetTipText"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthIsSimpleClsStatusBar"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSetBkColorClsStatusBar"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSetIconClsStatusBar"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSetMinHeight"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSetParts"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSetTextClsStatusBar"/></entry>
<entry>Sets the text for the specified part.</entry>
</row>
<row>
<entry><xref linkend="mthSetTipText"/></entry>
<entry>x.</entry>
</row>
<row>
<entry><xref linkend="mthSimple"/></entry>
<entry>x.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="tmthNewStatusBar" xreflabel="newStatusBar"><title>newStatusBar (dialog object method)</title>
<para>
StatusBar objects can not be instantiated by the programmer from Rexx code. Rather a StatusBar object is obtained by using
the <xref linkend="mthNewStatusBar"/>() method of the <xref linkend="chpDialogObject"/> object. The syntax is:
<programlisting>
<![CDATA[
>>-newStatusBar(--id--)--------------------------><
]]>
</programlisting>
</para>
</section> <!-- End newStatusBar() [PlainBaseDialog method] -->
<section id="tmthCreateStatusBar" xreflabel="createStatusBar"><title>createStatusBar (UserDialog method)</title>
<para>
A status bar control can be added to the dialog template for a <xref linkend="clsUserDialog"/> dialog through the <xref
linkend="mthCreateStatusBar"/>() method. The basic syntax is:
<programlisting> <![CDATA[
>>--createStatusBar(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)--><
+-,-style-+ +-,-attributeName-+
]]>
</programlisting>
</para>
</section> <!-- End UserDialog::createStatusBar() [UserDialog method] -->
<section id="tmthConnectStatusBarEvent" xreflabel="connectStatusBarEvent"><title>connectStatusBarEvent (dialog object method)</title>
<para>
To connect event notifications from a status bar control use the
<xref linkend="mthConnectStatusBarEvent"/>() method of the
<xref linkend="chpDialogObject"/> object. The basic syntax is:
<programlisting> <![CDATA[
>>-connectStatusBarEvent(--id--,--event--+----------------+--+--------------+--)---><
+--,-methodName--+ +-,-willReply--+
]]>
</programlisting>
</para>
</section> <!-- End connectStatusBarEvent() [EventNotification method] -->
<section id="tmthCreateStatusBarWindow" xreflabel="createStatusBarWindow"><title>createStatusBarWindow (CreateWindows method)</title>
<para>
A status bar control window can be created and added to any dialog through the <xref linkend="mthCreateStatusBarWindow"/>()
method. The basic syntax is:
<programlisting> <![CDATA[
>>--createStatusBarWindow(--id--+----------+--)--><
+-,-style--+
]]>
</programlisting>
</para>
</section> <!-- End CreateWindows::CreateStatusBarWindow() [CreateWindows method] -->
<section id="mthGetBorders" xreflabel="getBorders"><title>getBorders</title>
<indexterm><primary>getBorders</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getBorders</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getBorders-----------------------------------><
]]>
</programlisting>
<para>
Returns an array of three integers containing the borders of the status bar. The meaning of the three integers is explained
in the <emphasis role="italic">Remarks</emphasis> section.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns an array containing the borders on succees, or the <computeroutput>.nil</computeroutput> object on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The item at index 1 is the width of the horizontal border, the item at index 2 is the width of the vertical border, and
the item at index 3 is the width of the border between rectangles. The borders determine the spacing between the outside
edge of the window and the rectangles within the window that contain text. The borders also determine the spacing between
rectangles.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
::method onTest2 unguarded
sb = self~newStatusBar(IDC_STATUS)
a = sb~getBorders
say 'Width Horizontal Border:' a[1]
say 'Width Vetical Border :' a[2]
say 'Spacing Border :' a[3]
say
/* Output might be:
Width Horizontal Border: 0
Width Vetical Border : 2
Spacing Border : 2
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getBorders() -->
<section id="mthGetIconClsStatusBar" xreflabel="getIcon"><title>getIcon</title>
<indexterm><primary>getIcon</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getIcon</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getIcon(--index--)---------------------------><
]]>
</programlisting>
<para>
Retrieves the icon image for the specified part.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose icon is needed.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the icon for the specified part, or the <computeroutput>.nil</computeroutput> object if the part does not have an
icon.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from an application that assigns an icon to every part in the status bar. When the dialog is closed,
each icon is retrieved and released to free up system resources:
<programlisting>
<![CDATA[
::method leaving
status = self~newStatusBar(IDC_STATUSBAR)
do i = 1 to status~getParts
icon = status~getIcon(i)
icon~release
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getIcon() -->
<section id="mthGetParts" xreflabel="getParts"><title>getParts</title>
<indexterm><primary>getParts</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getParts</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getParts(--+-----------+--)------------------><
+--margins--+
]]>
</programlisting>
<para>
Returns the number of parts in the status bar, and optionally, the co-ordinate of the right edge of each part.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>margins [optional] [in / out]</term>
<listitem>
<para>
An <computeroutput>Array</computeroutput> object. If this argument is used, on return the indexes 1 through the number
of parts will contain the right margin of that part. I.e., index 1 will contain the right margin of part 1, index 2
will contain the right margin for part 2, etc.. If any index is -1, the position of the right edge for that part
extends to the right edge of the window.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the number of parts in the status bar.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example gets the number of parts in a status bar and also the right edge of each part:
<programlisting>
<![CDATA[
::method onTest2 unguarded
sb = self~newStatusBar(IDC_STATUS)
margins = .array~new
count = sb~getParts(margins)
say 'Status bar has' count 'parts.'
do i = 1 to count
say ' part' i 'right edge at' margins[i]
end
say
/* Output might be:
Status bar has 4 parts.
part 1 right edge at 50
part 2 right edge at 100
part 3 right edge at 200
part 4 right edge at -1
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getParts() -->
<section id="mthGetRectClsStatusBar" xreflabel="getRect"><title>getRect</title>
<indexterm><primary>getRect</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getRect</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getRect(--index--)---------------------------><
]]>
</programlisting>
<para>
Returns a <xref linkend="clsRect"/> object that contains the bounding rectangle of the specified part in this status bar.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single arguments is;
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose bounding rectangle is needed.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the bounding rectangle on success, or the the <computeroutput>.nil</computeroutput> object on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example attempts to get the bounding rectangle for part 6 to part 2, descending, for a status bar. The status bar
only has 4 parts:
<programlisting>
<![CDATA[
::method onTest2 unguarded
sb = self~newStatusBar(IDC_STATUS)
do i = 6 to 2 by -1
r = sb~getRect(i)
say 'Rect for part' i':' r
end
say
/* Output might be:
Rect for part 6: The NIL object
Rect for part 5: The NIL object
Rect for part 4: a Rect (202, 2, 325, 23)
Rect for part 3: a Rect (102, 2, 200, 23)
Rect for part 2: a Rect (52, 2, 100, 23)
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getRect() -->
<section id="mthGetTextClsStatusBar" xreflabel="getText"><title>getText</title>
<indexterm><primary>getText</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getText(--index--+---------+--)--------------><
+-,-info--+
]]>
</programlisting>
<para>
Retrieves the text of the specified part and optionally some extra information related to the part.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose text is needed.
</para>
</listitem></varlistentry>
<varlistentry><term>info [optional] [in / out]</term>
<listitem>
<para>
A <computeroutput>Directory</computeroutput> object in which some extra information can be retrieved. If this argument
is used, on return the object will contain these indexes:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">DRAWTYPE:</emphasis></term>
<listitem>
<para>
A key word that specifies the type of operation used to draw the text. This will be exactly one of the following
keywords:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">LOWERBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear lower than the plane of the window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn without borders.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOTABPARSING</emphasis></term>
<listitem>
<para>
Tab characters are ignored. See the <emphasis role="italic">Remarks</emphasis> section.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">OWNERDRAW</emphasis></term>
<listitem>
<para>
The text is drawn by the parent window. Owner draw is not currenly supported by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">POPOUT</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear higher than the plane of the window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">RTLREADING</emphasis></term>
<listitem>
<para>
The text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">TEXTLENGTH:</emphasis></term>
<listitem>
<para>
The length of the text string.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">TEXT:</emphasis></term>
<listitem>
<para>
The text of the specified part. This will be the same string as the return value for this method.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The text for the specified part.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks</emphasis></term>
<listitem>
<para>
By default text is left-aligned. This can be changed by embedding tab characters in the text. Text to the right of a
single tab character is center-aligned. Text to the right of 2 tab characters is right-aligned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example retrieves the text and the extra info for all the parts in a status bar:
<programlisting>
<![CDATA[
::method onTest2 unguarded
sb = self~newStatusBar(IDC_STATUS)
do i = 1 to sb~getParts
info = .directory~new
text = sb~getText(i, info)
say 'Text for part' i':' text
say ' Text length: ' info~textLength
say ' Text draw type:' info~drawType
say ' Text (again): ' info~text
say
end
say
/* Output might be:
Text for part 1: Ok
Text length: 2
Text draw type: LOWERBORDERS
Text (again): Ok
Text for part 2: Test
Text length: 4
Text draw type: LOWERBORDERS
Text (again): Test
Text for part 3: Friday
Text length: 6
Text draw type: LOWERBORDERS
Text (again): Friday
Text for part 4: Viking Victory
Text length: 14
Text draw type: LOWERBORDERS
Text (again): Viking Victory
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getText() -->
<section id="mthGetTextLength" xreflabel="getTextLength"><title>getTextLength</title>
<indexterm><primary>getTextLength</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getTextLength</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTextLength(--index--+---------+--)--------><
+-,-info--+
]]>
</programlisting>
<para>
Gets the length of the text for the specified pard of the status bar, and optionally the drawing technique of the text.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The index of the part whose text length is to be retrieved.
</para>
</listitem></varlistentry>
<varlistentry><term>info [optional] [in / out]</term>
<listitem>
<para>
A <computeroutput>Directory</computeroutput> object in which the drawing technique can be retrieved. If
this argument is used, on return the object will contain these indexes:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">DRAWTYPE:</emphasis></term>
<listitem>
<para>
A key word that specifies the type of operation used to draw the text. This will be exactly one of the following
keywords:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">LOWERBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear lower than the plane of the window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn without borders.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOTABPARSING</emphasis></term>
<listitem>
<para>
Tab characters are ignored. See the <xref linkend="mthSetTextClsStatusBar"/> method for an explanation of how
embedded tabs are used in the text string.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">OWNERDRAW</emphasis></term>
<listitem>
<para>
The text is drawn by the parent window. Owner draw is not currenly supported by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">POPOUT</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear higher than the plane of the window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">RTLREADING</emphasis></term>
<listitem>
<para>
The text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">TEXTLENGTH:</emphasis></term>
<listitem>
<para>
The length of the text string for the part.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The length of the text for the specified part, or -1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getTextLength() -->
<section id="mthGetTipText" xreflabel="getTipText"><title>getTipText</title>
<indexterm><primary>getTipText</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>getTipText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTipText(--index--)------------------------><
]]>
</programlisting>
<para>
Retrieves the ToolTip text for the specified part in this status bar.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The singke argument is:
</para>
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose ToolTip text is to be retrieved.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the tool tip text on success, or the empty string if there is no tool tip text.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Status bars must have the TOOLTIPS style to have tool tips.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::getTipText() -->
<section id="mthIsSimpleClsStatusBar" xreflabel="isSimple"><title>isSimple</title>
<indexterm><primary>isSimple</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>isSimple</secondary></indexterm>
<programlisting>
<![CDATA[
>>--isSimple-------------------------------------><
]]>
</programlisting>
<para>
Determines if this status bar is in <emphasis role="italic">simple</emphasis> mode.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if this status bar is in simple mode, false if it is not.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
A status bar in simple mode displays only one part. In addition, when the text of the status bar is set, the operating
system use a technique to redraw the text that reduces flicker. The <xref linkend="mthSimple"/> method is used to switch
a status bar between modes.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows a code snippet that is used in an application that has a basic mode and an advanced mode. The code
snippet is used to toggle between the 2 modes:
<programlisting>
<![CDATA[
...
sb = self~newStatusBar(IDC_STATUSBAR)
if sb~isSimple then do
self~statusBarUpdates = 'off'
self~setSimpleTasks
self~useWizrds = .true
end
else do
self~statusBarUpdates = 'on'
self~useAdavncedTasks
self~useWizrds = .false
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::isSimple() -->
<section id="mthSetBkColorClsStatusBar" xreflabel="setBkColor"><title>setBkColor</title>
<indexterm><primary>setBkColor</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setBkColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setBkColor(--colorRef--)---------------------><
]]>
</programlisting>
<para>
Sets the background color in this status bar.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>colorRef [required]</term>
<listitem>
<para>
A <xref linkend="defColorRef"/> value that specifies the new background color for the status bar. Use the <xref
linkend="mthColorRef"/> class method of the <xref linkend="clsImage"/> class to construct a proper COLORREF. Use
CLR_DEFAULT to set the background to the status bar's default color.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the previous background color, or CLR_DEFAULT if the status bar was using its default color.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Many dialog controls have a set background color API. However, when themes are turned on, it usually appears that the set
background color has no effect. Such is the case with the status bar control. Under most Windows 7 themes, the <emphasis
role="italic">setBkColor</emphasis> method appears to have no effect. That the method works can be seen by changing the
current theme to the Windows Classic them.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setBkColor() -->
<section id="mthSetIconClsStatusBar" xreflabel="setIcon"><title>setIcon</title>
<indexterm><primary>setIcon</primary><secondary>StatusBar class</secondary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setIcon</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setIcon(--icon--,--index--)------------------><
]]>
</programlisting>
<para>
Sets the icon for the specifie part in this status bar.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>icon [required]</term>
<listitem>
<para>
The icon <xref linkend="clsImage"/> for the part, or the <computeroutput>.nil</computeroutput> object to remove the
current icon for the part.
</para>
</listitem></varlistentry>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose icon is being changed.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the old icon, or the <computeroutput>.nil</computeroutput> object if there was no existing icon, on success.
Returns -1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Some dialog controls take ownership of image resources assigned to them and take care of releasing the resources. This is
not the case for the status bar. The ooDialog programmer is responsible for releasing the icon images when they are no
longer needed.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows a status bar with 4 parts. An image list is used with 4 icons in it. After loading the image list and
setting up the status bar, the first 4 icons in the image list are assigned to the 4 parts in the status bar:
<programlisting>
<![CDATA[
::method initDialog
expose imageList status
...
self~loadImageList
status = self~newStatusBar(IDC_STATUSBAR)
...
do i = 1 to 4
icon = imageList~getIcon(i)
status~setIcon(icon, i)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setIcon() -->
<section id="mthSetMinHeight" xreflabel="setMinHeight"><title>setMinHeight</title>
<indexterm><primary>setMinHeight</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setMinHeight</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setMinHeight(--minHeight--)------------------><
]]>
</programlisting>
<para>
Sets the minimum height of a status bar's drawing area.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>minHeight</term>
<listitem>
<para>
The minimum height, in pixels, that is desired.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
MSDN says the minimum height is set to: <emphasis role="italic">minHeight</emphasis> plus twice the width of the vertical
border. The <xref linkend="mthGetBorders"/> method can be used to get the width of the vertical border.
</para>
<para>
However, experimentation seems to show that the minimum height is actually set to: <emphasis
role="italic">minHeight</emphasis> plus 1 * the width of the vertical border. But MSDN is vague as to what exactly is
getting set. The doc says: <emphasis role="italic">minimum height of a status window's drawing area.</emphasis> The
drawing area of a window usually means the client area of a window. Testing shows that the client area height is set to
<emphasis role="italic">minHeight</emphasis> plus the width of the vertical border.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In this example, the minimum height of the client area of the status bar is set to 28 pixels. The actual height was
verified using Spy++
<programlisting>
<![CDATA[
sb = self~newStatusBar(IDC_STATUS)
-- We want the minimum heigt to be 28 pixels.
min = 28
borders = sb~getBorders
min -= borders[2]
sb~setMinHeight(min)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setMinHeight() -->
<section id="mthSetParts" xreflabel="setParts"><title>setParts</title>
<indexterm><primary>setParts</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setParts</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setParts(--rightEdges--)---------------------><
]]>
</programlisting>
<para>
Sets the number of parts in a status window and the width of each part.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>rightEdges [required]</term>
<listitem>
<para>
An array of positive integers. Each integer specifies the right edge of a part in client <xref
linkend="defScreenCoordinates"/>, in pixels. The array can not be sparse. The number of items in the array will be the
number parts created. A -1 specifies the remaing area of the status bar.
</para>
</listitem></varlistentry>
</variablelist> </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
True on success, false on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
It is important to note that the integers in the area represent the co-ordinate of the right edge of the part, not the
width of the part. A mistake the author often makes. For example, if a status bar has a width of 300, to divide it into 3
equal parts, use an array of 100, 200, -1. Not an array of 100, 100, -1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example divides the status bar up into 4 parts. The first 3 parts are each 75 pixels in width and the fourth part
takes of the remainder of the status bar. Its width will be dependent on the width of the status bar. If the width of the
status bar was only 200 pixels, the fourth part would not show at all and the third part would only be 50 pixels wide:
<programlisting>
<![CDATA[
status = self~newStatusBar(IDC_STATUSBAR)
parts = .array~of(75, 150, 225, -1)
status~setParts(parts)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setParts() -->
<section id="mthSetTextClsStatusBar" xreflabel="setText"><title>setText</title>
<indexterm><primary>setText</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setText(--text--,--index--+-------------+--)----------------><
+-,-drawType--+
]]>
</programlisting>
<para>
Sets the text for the specified part.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text for the part.
</para>
</listitem></varlistentry>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the part whose text is to be set.
</para>
</listitem></varlistentry>
<varlistentry><term>drawType [optional]</term>
<listitem>
<para>
A single keyword that specifies the drawing technique used by the control to draw the text. The following keywords are
accepted, case is not significant:
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">LOWERBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear lower than the plane of the window. This is the default if the <emphasis
role="italic">drawType</emphasis> argument is omitted.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOBORDERS</emphasis></term>
<listitem>
<para>
The text is drawn without borders.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">NOTABPARSING</emphasis></term>
<listitem>
<para>
Tab characters are ignored. See the <emphasis role="italic">Remarks</emphasis> section.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">OWNERDRAW</emphasis></term>
<listitem>
<para>
The text is drawn by the parent window. Owner draw is not currenly well supported by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">POPOUT</emphasis></term>
<listitem>
<para>
The text is drawn with a border to appear higher than the plane of the window.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">RTLREADING</emphasis></term>
<listitem>
<para>
The text will be displayed in the opposite direction to the text in the parent window.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, false on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
By default text is left-aligned. This can be changed by embedding tab characters in the text. Text to the right of a
single tab character is center-aligned. Text to the right of 2 tab characters is right-aligned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example divides a status bar into 4 parts and then sets the text for the parts
<programlisting>
<![CDATA[
status = self~newStatusBar(IDC_STATUSBAR)
parts = .array~of(75, 150, 225, -1)
status~setParts(parts)
status~setText("Friday", 1, 'POPOUT')
status~setText("January", 2, 'POPOUT')
status~setText("22nd", 3)
status~setText("Viking Victory", 4)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setText() -->
<section id="mthSetTipText" xreflabel="setTipText"><title>setTipText</title>
<indexterm><primary>setTipText</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>setTipText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setTipText(--text--,--index--)---------------><
]]>
</programlisting>
<para>
Sets the ToolTip text for a part in a status bar.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
</para>
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text of the tool tip.
</para>
</listitem></varlistentry>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-base index of the part whose tool tip is being set.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The length of <emphasis role="italic">text</emphasis> can not be longer than 511. The status bar must have the TOOLTIPS
style to display a tool tip. The tool tip is only displayed under these circumstances:
</para>
<itemizedlist>
<listitem>
<para>
When the corresponding part in the status bar contains only an icon.
</para>
</listitem>
<listitem>
<para>
When the corresponding pane in the status bar contains text that is truncated due to the size of the pane.
</para>
</listitem>
</itemizedlist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example divides a status bar up into 4 parts. Since the first 3 parts are not wide enough to display the entire text
string, a tool tip is added for each of them:
<programlisting>
<![CDATA[
status = self~newStatusBar(IDC_STATUSBAR)
parts = .array~of(75, 150, 225, -1)
status~setParts(parts)
text = "Thank God it is Friday"
status~setText(text, 1, 'POPOUT')
status~setTipText(text, 1)
text = "January in northen Canada"
status~setText(text, 2, 'POPOUT')
status~setTipText(text, 2)
text = "The 22nd Bomber Squadron"
status~setText(text, 3)
status~setTipText(text, 3)
status~setText("Viking Victory", 4)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::setTipText() -->
<section id="mthSimple" xreflabel="simple"><title>simple</title>
<indexterm><primary>simple</primary></indexterm>
<indexterm><primary>StatusBar class</primary><secondary>simple</secondary></indexterm>
<programlisting>
<![CDATA[
>>--simple(--+---------+--)----------------------><
+--onOff--+
]]>
</programlisting>
<para>
Specifies whether a status window displays simple text or displays all window parts set by a previous <xref
linkend="mthSetParts"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>onOff [optional]</term>
<listitem>
<para>
True to put the status bar in simple mode, false to take it out of simple mode. The default if the argument is omitted
is true.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
A status bar in simple mode displays only one part. In addition, when the text of the status bar is set, the operating
system use a technique to redraw the text that reduces flicker. The <xref linkend="mthIsSimple"/> method can be used to
test what mode the status bar is currently in. In addition the <xref linkend="kywStatusBarSIMPLEMODECHANGE"/> event can
be connected for the statust bar. The event handler will be invoked each time the status bar mode swtiches to or from
simple.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This simple code snippet merely toggles the simple mode each time it is executed:
<programlisting>
<![CDATA[
if sb~isSimple then do
sb~simple(.false)
end
else do
sb~simple(.true)
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End StatusBar::simple() -->
</chapter> <!-- End StatusBar class -->