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
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
|
\documentclass[11pt,twoside]{book}
\usepackage{a4wide}
\usepackage{html}
\usepackage{makeidx}
\usepackage{graphicx}
\newcommand{\cident}[1] {%
{\tt #1}}
\newcommand{\code}[1] {%
{\tt #1}}
\newcommand{\ident}[1] {%
{\tt\large #1}}
\newenvironment{blockindent}{\begin{quotation}}{\end{quotation}\vspace{\parskip}}
\newcommand{\option}[3]{%
\label{opt:#1}
\index{#1}
\htmlrule[WIDTH="300" left]
\begin{tabular}{rl}
Command line switch: & \ident{-#1} \\
Database name: & \ident{#2} \\
Database class: & \ident{#3} \\
\end{tabular}}
\newcommand{\command}[3]{%
\label{cmd:#2}
\index{#2}
\htmlrule[WIDTH="300" left]
{\tt\large #1 {\bf #2} #3}}
\newcommand{\zinccmd}[2]{%
\command{pathname}{#1}{#2}}
\newcommand{\mapinfocmd}[3]{%
\label{mpcmd:#2}
\index{#2}
\htmlrule[WIDTH="300" left]
{\tt\large mapinfo #1 {\bf #2} #3}}
\newcommand{\attrtype}[1]{%
\label{attrtype:#1}
\index{#1}
\htmlrule[WIDTH="300" left]
{\tt {\bf #1}}
\vspace{-2\parskip}}
\newcommand{\available}[1]{%
\hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{obj:#1}}
\newcommand{\optref}[1]{%
\hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{opt:#1}
}
\newcommand{\cmdref}[1]{%
\index{#1}
\hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{cmd:#1}
}
\newcommand{\attribute}[3]{%
\ident{-#1} \hyperref[no]{\tt \bf #2}{\ident{#1}}{attrtype:#2}
\begin{quotation}#3\end{quotation}
}
\newcommand{\object}[1]{%
\label{obj:#1}
}
\newcommand{\concept}[1]{%
\label{concept:#1}
}
\newcommand{\objectref}[1]{%
\hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{obj:#1}
}
\newcommand{\conceptref}[2]{%
\hyperref[page]{#1}{#1 (page }{)}{concept:#2}
}
\makeindex
\parindent 0cm
\parskip 0.2cm
\title{Zinc reference manual\\Version 3.0}
\author{Patrick Lecoanet}
\date{21 Sep 2000}
\begin{document}
\maketitle
This reference manual describes the Tk \ident{zinc} widget interface. It shows
how to create and configure a \ident{zinc} widget, and how to use the commands
it provides to create and manipulate items.
The \ident{zinc} widget is available for the Tcl/Tk and the Perl/Tk environment.
A binding over Tcl/Tk is also provided for Python. This document is Tcl/Tk
oriented but it should be easy for Perl and Python programmers to adapt.
The \ident{zinc} command creates a new \ident{zinc} widget, the general form is
\begin{quotation}
{\tt zinc pathname ?options?}
\end{quotation}
{\tt pathname} name the new widget and specifies where in the widget hierarchy
it will be located. Any number of options may be specified on the command line
or in the option database to modify the global behavior of the widget. Available
options are described in the \ident{Widget options} chapter.
\ident{Zinc} widgets are very similar to Tk \ident{canvas}es in that they support
structured graphics. Like the \ident{canvas}, \ident{zinc} implements items used to
display graphical entities. Those items can be manipulated and bindings can be
associated with them to implement interaction behaviors. But unlike the \ident{canvas},
\ident{zinc} can structure the items in a hierarchy, has support for affine 2D
transforms, clipping can be set for sub-trees of the item hierarchy and the item
set is quite more powerful including field specific items for Air Traffic systems.
\chapter{Widget options}
\concept{options}
\option{borderwidth}{borderWidth}{BorderWidth}
\begin{blockindent}
Specifies the width of the 3d border that should be displayed around the widget
window. This border does not overlap the active zinc display area. The area
requested from the geometry manager (or the window manager if applicable)
is the overall area, display area plus borders. This value can be given
in any of the forms valid for coordinates (See \cident{TkGet\_Pixels}).
The default value is 2.
\end{blockindent}
\option{backcolor}{backColor}{BackColor}
\begin{blockindent}
This the color that will be used to fill the zinc window. It is also
used as a default color for some item attributes of type color. See each
color attribute for the actual source of the default color. Its default
value is white.
\end{blockindent}
\option{cursor}{cursor}{Cursor}
\begin{blockindent}
Specifies the cursor to use when the pointer is in the zinc window.
The default value is set to preserve the cursor provided at widget
creation.
\end{blockindent}
\option{font}{font}{Font}
\begin{blockindent}
The font specified by this option is used as a default font
for item attributes of type font. Its default value is
-adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*.
\end{blockindent}
\option{forecolor}{foreColor}{ForeColor}
\begin{blockindent}
The color specified by this option is used as a default color
for many item attributes of type color. See each each color
attribute for the actual source of the default color. Its
default value is black.
\end{blockindent}
\option{fullreshape}{fullReshape}{FullReshape}
\begin{blockindent}
If this option is True, the shape applied to the zinc window will
propagate up the window hierarchy to the top level window. The
result will be a shaped top level. See also the \optref{reshape} option,
it controls whether a shape is applied to the zinc window or not.
The default is True.
\end{blockindent}
\option{height}{height}{Height}
\begin{blockindent}
Specifies the height of the actual zinc area (i.e, this dimension
does not include the border width). This value can be given in any of
the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is
100 pixels.
\end{blockindent}
\option{highlightbackground}{highlightBackground}{HighlightBackground}
\begin{blockindent}
Specifies the color to display in the traversal highlight region when the
widget does not have the input focus. The default value is \#c3c3c3.
\end{blockindent}
\option{highlightcolor}{highlightColor}{HighlightColor}
\begin{blockindent}
Specifies the color to use for the traversal highlight rectangle that is
drawn around the widget when it has the input focus. The default value
is Black.
\end{blockindent}
\option{highlightthickness}{highlightThickness}{HighlightThickness}
\begin{blockindent}
Specifies a non-negative value indicating the width of the highlight
rectangle drawn around the outside of the widget when it has the input
focus. The value may have any of the forms acceptable to \cident{Tk\_GetPixels}.
If the value is zero, no focus highlight is drawn around the widget.
The default value is 2.
\end{blockindent}
\option{insertbackground}{insertBackground}{InsertBackground}
\begin{blockindent}
Specifies the color to use as background in the area covered by the
insertion cursor. This color will normally override either the normal
background for the widget (or the selection background if the insertion
cursor happens to fall in the selection). The default value is Black.
\end{blockindent}
\option{insertofftime}{insertOffTime}{InsertOffTime}
\begin{blockindent}
Specifies a non-negative integer value indicating the number of
milliseconds the insertion cursor should remain off in each blink cycle.
If this option is zero then the cursor is on all the time. The
default value is 300.
\end{blockindent}
\option{insertontime}{insertOnTime}{InsertOnTime}
\begin{blockindent}
Specifies a non-negative integer value indicating the number of
milliseconds the insertion cursor should remain on in each blink cycle.
The default value is 600.
\end{blockindent}
\option{insertwidth}{insertWidth}{InsertWidth}
\begin{blockindent}
Specifies a value indicating the width of the insertion cursor.
The value may have any of the forms acceptable to \cident{Tk\_GetPixels}.
The default value is 2.
\end{blockindent}
\option{mapdistancesymbol}{mapDistanceSymbol}{MapDistanceSymbol}
\begin{blockindent}
This option specifies the symbol to be used as a milestone
along map lines. This option can be given any Tk bitmap which
can be obtained by \cident{Tk\_GetBitmap}. The spacing between markers is
10 nautic miles. The default value is AtcSymbol19.
\end{blockindent}
\option{maptextfont}{mapTextFont}{MapTextFont}
\begin{blockindent}
Specifies the font used to draw the texts contained in maps. The
default is -adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*.
\end{blockindent}
\option{overlapmanager}{overlapManager}{OverlapManager}
\begin{blockindent}
This option accepts an item id. It specifies if the label overlapping
avoidance algorithm should be allowed to do its work on the track labels
and which group should be considered to look for tracks. The default
is to enable the avoidance algorithm in the top group (id 1).
\end{blockindent}
\option{pickaperture}{pickAperture}{PickAperture}
\begin{blockindent}
Specifies the size of an area around the pointer that is used to tell
if the pointer is inside an item. This is useful to lessen the precision
required when picking graphical elements. This value must be a positive
integer. It defaults to 1.
\end{blockindent}
\option{relief}{relief}{Relief}
\begin{blockindent}
Specifies the border relief. This option can be given any legal value
for a relief (See \cident{Tk\_GetRelief} for a description of possible values).
\end{blockindent}
\option{reshape}{reshape}{Reshape}
\begin{blockindent}
Specifies if the clipping shape that can be set in the top group item
should clip the top group children or be used to reshape the zinc
window. This option can be used with the fullreshape option to reshape
the toplevel window as well. The default value is True.
\end{blockindent}
\option{selectbackground}{selectBackground}{SelectBackground}
\begin{blockindent}
Specifies the background color to use for displaying the selection
in text items. The default value is \#a0a0a0.
\end{blockindent}
\option{speedvectorlength}{speedVectorLength}{SpeedVectorLength}
\begin{blockindent}
Specifies the duration of track speed vectors. This option is expressed
using a time unit that should be chosen by the application (often minutes)
and kept coherent with the unit of the track attribute \ident{speedvector}
(often nautic mile / minutes). The default value is 3.
\end{blockindent}
\option{takefocus}{takeFocus}{TakeFocus}
\begin{blockindent}
(From the Tk options manpage).
Determines whether the window accepts the focus during keyboard traversal
(e.g., Tab and Shift-Tab). Before setting the focus to a window, the
traversal scripts consult the value of the takeFocus option. A value of 0
means that the window should be skipped entirely during keyboard traversal.
1 means that the window should receive the input focus as long as it is
viewable (it and all of its ancestors are mapped). An empty value for the
option means that the traversal scripts make the decision about whether or
not to focus on the window: the current algorithm is to skip the window if
it is disabled, if it has no key bindings, or if it is not viewable. If the
value has any other form, then the traversal scripts take the value, append
the name of the window to it (with a separator space), and evaluate the
resulting string as a Tcl script. The script must return 0, 1, or an empty
string: a 0 or 1 value specifies whether the window will receive the input
focus, and an empty string results in the default decision described above.
Note: this interpretation of the option is defined entirely by the Tcl scripts
that implement traversal: the widget implementations ignore the option
entirely, so you can change its meaning if you redefine the keyboard traversal
scripts. The default value is empty.
\end{blockindent}
\option{tile}{tile}{Tile}
\begin{blockindent}
Specifies an image name to be used as a tile for painting the zinc window
background. The default value is none (the empty string).
\end{blockindent}
\option{trackmanagedhistorysize}{trackManagedHistorySize}{TrackManagedHistorySize}
\begin{blockindent}
This option accepts only positive integers. It specifies the size of
the past position list that can be maintained by the track items. See
also the \optref{trackmanagehistory} option and the \ident{visiblehistorysize}
track attribute. The default value is 6.
\end{blockindent}
\option{trackmanagehistory}{trackManageHistory}{TrackManageHistory}
\begin{blockindent}
This option accepts any form valid for a boolean. It specifies if
the track items should maintain a list of their past positions to be
displayed as trailing speckles. If this option is turned off and then
back on, the history list is erased and the collection is resumed at
the next available position. The number of position collected in the
history list is specified by the option \optref{trackmanagedhistorysize}.
When this many positions are collected, the oldest is dropped to make
room for the new one on a first in first out basis. The number of past
positions actually displayed if specified for each track by the
attribute \ident{visiblehistorysize}.
The default is to enable the history collection.
\end{blockindent}
\option{width}{width}{Width}
\begin{blockindent}
Specifies the width of the actual zinc area (i.e, this dimension
does not include the border width). This value can be given in any of
the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is
100 pixels.
\end{blockindent}
\chapter{Groups, Display List and Transformations}
\concept{coordinates}
la liaison groupe transformation
l'empilage des groupes et la composition de transfo
coordonnées du top group
\chapter{Item IDs and Tags}
\concept{tagOrId}
id
tag all
tag current
tags speciaux dans les items textes
tags
tags dans bind (syntaxe pour spécifier les parties et les champs).
Décrire les ids, tags, field tags et part tags. Les deux derniers
n'étant employes que par bind doit-on les décrire ici ou dans la commande ?
Parler de current, all.
\chapter{Indices}
\chapter{Widget commands}
The available commands are listed in alphabetical order.
The command set for the \ident{zinc} widget is much inspired by the \ident{canvas}
command set. Someone comfortable with the \ident{canvas} should not have much trouble
using the \ident{zinc}'s commands. Eventually, the command set will be a superset
of the \ident{canvas} command set.
\vspace{.5cm}
\zinccmd{add}{?type group? ?args? ?option value? ... ?option? value?}
\begin{blockindent}
This command is used to create new items in a zinc widget. It can be called with
no parameters to return the list of all item types currently known by
the zinc widget. It can also be called with a valid item type as first
parameter and a group item as second parameter to create a new item of this
type in the given group.
After these first two parameters come some item type specific arguments.
Here is detailed description of these arguments by type:
\begin{description}
\item{arc} \\
The arc type expects a list of four floating point numbers ``xo yo xc yc'',
giving the coordinates of the origin and the corner of the enclosing rectangle.
\item{bezier} \\
The bezier type expects a list of floating point numbers ``x0 y0 x1 y1 ... xn yn'',
giving the coordinates of the bezier segment controls. The number of values
should be pair (or the last value will be discarded), and there should be at
least two control points. The segments are built as follow: if there is at
least four points, they are used as the four controls of a cubic Bezier. Then,
if more than four points are provided , the first three are discarded and
the process is restarted using as first control the last control of the previous
segment. The process is repeated until there is less than four points left.
If three points are left, a segment is drawn using the second point for the
two off-curve controls. If two points are left, a line segment is drawn
between the two.
\item{curve} \\
The curve type expects a list of floating point numbers ``x0 y0 x1 y1 ... xn yn'',
giving the coordinates of the curve vertices. The number of values should be
pair (or the last value will be discarded) but the list can be empty to build
an empty invisible curve. This curve can be defined later with the \cmdref{contour}
or \cmdref{coords} commands. As a side effect of the curve behavior, a one vertex
curve is essentially the same as an empty curve, it only waste some more memory.
\item{rectangle} \\
The rectangle type expects a list of four floating point numbers ``xo yo xc yc'',
giving the coordinates of the origin and the corner of the rectangle.
\item{tabular, track, waypoint} \\
These types expects the number of fields they will manage in the label or
tabular form. This number must be greater or equal to zero.
\item{group, icon, map, reticle, text, window} \\
These types doesn't expect type specific arguments.
\end{description}
Following the creation args the command accept any number of
attributes\ -\ values pairs to configure the newly created item.
All the configurable item type attributes are valid in this context. The
command returns the item id.
\end{blockindent}
\zinccmd{addtag}{tag searchSpec ?arg arg ...?}
\begin{blockindent}
This command add the given tag to all items matching the
search specification. If the tag is already present on some item,
nothing is done for that item. The command has no effect if no
item satisfy the given criteria. The command returns an empty
string.
Many commands take a group as a starting point for the search. If no
group is given, the top group is assumed. In any cases, the starting
group will not be reported in the search result. This means that the
top group will never be reported in a search and that tags cannot be
attached to it except in specifying its id.
The search specification and the associated arguments can
take the following forms:
\begin{description}
\item{\tt above tagOrId ?inGroup? ?recursive?} \\
Selects the item just above the one given by {\tt tagOrId}. If
{\tt tagOrId} names more than one item, the topmost of these
items in the display list will be used. If {\tt tagOrId} does
not refer to any item then nothing happen. The inGroup and
recursive optional parameters can be specified to restrict the
search with a tag matching several items. inGroup specifies a
group to start with instead of the top group and recursive
tells if the search should descend in the item tree or not.
\item{\tt all ?inGroup? ?recursive?} \\
Selects all the items in the widget. The inGroup and
recursive can be specified to restrict the search. inGroup specifies
a group to start with instead of the top group and recursive tells
if the search should descend in the item tree or not.
\item{\tt atpriority priority ?inGroup? ?recursive?} \\
Selects all the items at the given priority. The inGroup and
recursive can be specified to restrict the search. inGroup specifies
a group to start with instead of the top group and recursive tells
if the search should descend in the item tree or not.
\item{\tt below tagOrId ?inGroup? ?recursive?} \\
Selects the item just below the one given by {\tt tagOrId}. If
{\tt tagOrId} names more than one item, the lowest of these
items in the display list will be used. If {\tt tagOrId} does
not refer to any item then nothing happen. The inGroup and
recursive optional parameters can be specified to restrict the
search with a tag matching several items. inGroup specifies a
group to start with instead of the top group and recursive
tells if the search should descend in the item tree or not.
\item{\tt closest x y ?halo? ?start?} \\
Selects the item closest to the point {\tt x - y}. Any item overlapping
the point is considered as closest and the topmost is selected. If {\tt halo}
is given, it defines the size of the point {\tt x - y}. {\tt halo} must
be a non negative integer. If {\tt start} is specified, it must be
an item tag or id. If it names a valid item (for a tag, the lowest
item with the tag is considered), the search starts with the item
below {\tt start} instead of the first item in the display
order. If {\tt start} does not name a valid item, it is ignored.
\item{\tt enclosed xo yo xc yc} \\
Selects all the items completely enclosed in the rectangle whose
origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc}
must be no greater than {\tt xo} and {\tt yo} must be no greater
than {\tt yc}. All coordinates must be integers.
It may be necessary to update the zinc internal geometry with a call
to {\tt update} if the current state is not stable (i.e before calling
the main loop or in a callback after modifying the transform or doing
something else affecting the geometry of items).
\item{\tt overlapping xo yo xc yc} \\
Selects all the items that overlaps or are enclosed in the rectangle
whose origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc}
must be no greater than {\tt xo} and {\tt yo} must be no greater than
{\tt yc}. All coordinates must be integers. See also the {\tt enclosed}
variant above for a discussion on updating the geometry.
\item{\tt withtag tagOrId ?inGroup? ?recursive?} \\
Selects all the items given by {\tt tagOrId}. The inGroup and
recursive can be specified to restrict the search. inGroup specifies
a group to start with instead of the top group and recursive tells
if the search should descend in the item tree or not.
\item{\tt withtype type ?inGroup? ?recursive?} \\
Selects all the items of type {\tt type}. The inGroup and
recursive can be specified to restrict the search. inGroup specifies
a group to start with instead of the top group and recursive tells
if the search should descend in the item tree or not.
\end{description}
\end{blockindent}
\zinccmd{anchorxy}{tagOrId anchor}
\begin{blockindent}
Returns the (device) coordinate of an item anchor. If no item is
named by {\tt tagOrId} or if the item doesn't support anchors, an
error is raised. If more than one item match {\tt tagOrId}, the topmost
in display list order is used.
\end{blockindent}
\zinccmd{bbox}{tagOrId ?tagOrId ...?}
\begin{blockindent}
Returns a list of 4 numbers describing the (device) coordinates of the origin
and corner of a rectangle bounding all the items named by the {\tt tagOrId}
arguments. If no items are named by the {\tt tagOrId} or if the matching items
have an empty bounding box, an empty string is returned.
\end{blockindent}
\zinccmd{becomes}{}
\begin{blockindent}
Not yet implemented.
\end{blockindent}
\zinccmd{bind}{tagOrId ?sequence? ?command?}
\begin{blockindent}
This command associates {\tt command} with the item tag, item id, part tag
{\tt tagOrId}. If an event sequence matching {\tt sequence}
occurs for an item, or an item part, the command will be invoked.
If all parameters are specified a new binding between {\tt sequence} and
{\tt command} is established, overriding any existing binding for the
sequence. If the first character of {\tt command} is ``+'', then
{\tt command} augments the existing binding instead of replacing it.
In this case the command returns an empty string. If the {\tt command}
parameter is omitted, the command return the {\tt command} associated
with {\tt tagOrId} and {\tt sequence} or an error is raised if there
is no such binding. If only {\tt tagOrId} is specified the command
returns a list of all the sequences for which there are bindings for
{\tt tagOrId}.
This widget command is similar to the \ident{bind} command except that
it operates on \ident{zinc} items instead of widgets. Another difference
with the \ident{bind} command is that only mouse and keyboard related events
can be specified (such as \ident{Enter}, \ident{Leave}, \ident{ButtonPress},
\ident{ButtonRelease}, \ident{Motion}, \ident{KeyPress}, \ident{KeyRelease}).
The \ident{bind} manual page is the most accurate place to look for a
definition of {\tt sequence} and {\tt command} and for a general understanding
of how the binding mecanism works.
The handling of events in the widget is done with respect to the
current item and when applicable the current item part (see
\conceptref{Item IDs and tags}{tagOrId} for a discussion of the
\ident{current} tag and the special tags used in bindings). \ident{Enter}
and \ident{Leave} events are trigerred for an item when it becomes or cease
to be the current item. Mouse related events are reported with respect to
the current item. Keyboard related events are reported with respect to the
focus item (which can be the current item or none).
It is possible that several bindings match a particular event sequence.
When this occurs, all matching bindings are triggered. The order of
invocation is as follow: the binding associated with the tag \ident{all}
is invoked first, followed by the bindings associated with the item tags
in order, followed by followed bindings associated with the part tags if
relevant, followed by the binding associated with the item id, followed
by the binding associated with the item part if relevant.
If there are more than one binding for a single tag, only the most
specific is triggered.
If bindings have been registered for the widget window using the
\ident{bind} command, they are invoked in addition to bindings registered
for the items using this widget command. The bindings for items will be
invoked before the bindings for the window.
\end{blockindent}
\zinccmd{cget}{option}
\begin{blockindent}
Returns the current value of the widget option given by {\tt option}.
{\tt option} may be any of the options described in the
chapter \conceptref{Widget options}{options}.
\end{blockindent}
\zinccmd{chggroup}{tagOrId group ?adjustTransform?}
\begin{blockindent}
Move the item described by {\tt tagOrId} in the group described
by {\tt group}. If {\tt tagOrId} or {\tt group} describe more
than one item, the first in display list order will be used.
If {\tt adjustTransform} is specified, it will be interpreted
as a boolean. A true value will lead to an adjustment of the
item transform in order to maintain an identical display
rendering of the item regardless of its new position in the
display hierarchy. If {\tt adjustTransform} is omitted, it
defaults to false.
\end{blockindent}
\zinccmd{clone}{tagOrId ?attr value ...?}
\begin{blockindent}
Create an exact copy of all the items described by {\tt tagOrId}.
The copy goes recursively for group items (deep copy). After copying
the pairs {\tt attr value} are used, if any, to reconfigure
the items. Any attribute that as no meaning in the context of some item
is ignored. The items down the hierarchy of group items are not
concerned by the configuration phase. The command returns the list
of cloned items id in creation order (display list order of the models).
No item id will be returned for items cloned in the hierarchy of
cloned groups.
\end{blockindent}
\zinccmd{configure}{?option? ?value? ?option value ...?}
\begin{blockindent}
Query or modify the options of the widget. If no {\tt option}
is given, returns a list describing all the supported options (see the
chapter \conceptref{Widget options}{options}). If an {\tt option} is
specified without any {\tt value}, the command returns a list
describing the named option. If some
{\tt option - value} pairs are given, then the corresponding options
are changed and the command return an empty string.
\end{blockindent}
\zinccmd{contour}{tagOrId operator coordListOrTagOrId}
\begin{blockindent}
Manipulate contours on items that can handle multiples geometric
contours. Currently only curve items can do this.
{\tt tagOrId} specifies the item whose contours will be modified.
If {\tt tagOrId} describes more than one item, the first in
display list order will be used.
{\tt coordListOrTagOrId} specifies a list of coordinates or an
item describing a contour. If a list is specified it should
contain a pair number of floating point values specifying the
contour vertices X and Y in order. If a tag or an id is specified,
it is should be from one of these classes: arc, bezier curve,
icon, rectangle, tabular, text, window. The external shape of
the item will be used as the contour. If {\tt coordListOrTagOrId}
describes more than one item, the first in display list order
will be used.
{\tt operator} specifies the operation that will be carried. This
can be:
\begin{description}
\item{diff} Substract the given contour from the item contours
\item{inter} Intersect the given contour and the item contours,
replacing the original contours by the intersection.
\item{union} Compute the union of the given contour and the
item's contours, replacing the original contours by the union.
\item{xor} Compute the exclusive or of the given contour and the
item's contours, replacing the original contours by the result.
\end{description}
An error in generated if the items are not of a correct type or if
the coordinate list is malformed.
The order of the contours generated by the command is not easily
predictable, as a result, it is not easy to use the coords command
to edit those contours. Another side effect is the reordering of
the contours vertices depending whether the contour is classified
as an internal hole or as an external contour (externals are clockwise
while holes are counter-clockwise). This is usually not
a problem if the curve item is used to describe polygonal areas but
can lead to unpredicted effects on real unclosed curves.
\emph{NOTE: This command is available only when GPC support has been
built in Zinc.}
\end{blockindent}
\zinccmd{coords}{tagOrId ?add/remove? ?contour? ?index? ?coordList?}
\begin{blockindent}
Query or changes the coordinates of the item described by {\tt tagOrId}.
If {\tt tagOrId} describes more than one item, the first in display
list order is used. The optional {\tt contour} gives the contour, if
available, that should be operated. The default contour is 0. The
optional {\tt index} gives the vertex index that should be operated
in the given contour. The optional {\tt coordList} is a list of one or
more vertices described as X, Y floating point values that will be used
to replace or add coordinates to the current contour.
Almost all items can be manipulated by this command, the map item is
the only current exception. The effect of the command can be quite
different depending on the item. For icons, texts, windows, tabulars,
the coordinates of the anchor can be modified or read. For groups, the
coordinates of the origin of the transformation can be set or read. For
tracks and waypoints, the coordinates of the current position can be set
or read. For tracks setting the current position this way will make the
previous position shift into the history. For reticles, the coordinates
of the center can be set or read. For arcs and rectangles, the coordinates
of the origin and corner can be set or read. For beziers, the coordinates
of the vertices can be set or read and it is possible to remove or add
vertices to an existing item. For curves, the capabilities of bezier are
extended to support multiple contours. For all items that do not support
multiple contours (currently all except curves) the {\tt contour} parameter
should be omitted or specified as zero.
The optional parameters must be combined to produce a given behavior.
Here are the various form recognized by the command:
\begin{description}
\item{\code{.r coords tagOrId contour}}\\
Get all coordinates of contour. All items can answer if contour
is zero. Curves can handle other contours.
\item{\code{.r coords tagOrId contour coordList}}\\
Set all coordinates of contour. All items can do it if contour
is zero. Curves can handle other contours.
For groups, icons, texts, windows, tabulars, reticles, tracks,
waypoints, only the first vertex will be used. For rectangles and
arcs, only the first two vertices will be used. Beziers and curves can
handle any number of vertices.
\item{\code{.r coords tagOrId contour index}}\\
Get coordinate at index in contour. All items can answer if contour
is zero. Curves can handle other contours. For groups, icons, texts,
windows, tabulars, reticles, tracks, waypoints, index mst be zero.
For rectangles and arcs, index must zero or one.
\item{\code{.r coords tagOrId contour index coordList}}\\
Set coordinate at index in contour. All items can do it if contour
is zero. Curves can handle other contours. For groups, icons, texts,
windows, tabulars, reticles, tracks, waypoints, index must be zero.
For rectangles and arcs, index must zero or one.
\item{\code{.r coords tagOrId remove contour index}}\\
Remove coordinate at index in contour. Can only be handled by beziers
and curves. Only curves can handle contours other than zero.
\item{\code{.r coords tagOrId add contour coordList}}\\
Add coordinates at the end of contour. Can only be handled by beziers
and curves. Only curves can handle contours other than zero.
\item{\code{.r coords tagOrId add contour index coordList}}\\
Add coordinates at index in contour. Can only be handled by beziers
and curves. Only curves can handle contours other than zero.
\end{description}
And the slightly abbreviated forms:
\begin{description}
\item{\code{.r coords tagOrId}}\\
Get all coordinates of contour 0. See first form.
\item{\code{.r coords tagOrId coordList}}\\
Set all coordinates of contour 0. See second form.
\item{\code{.r coords tagOrId remove index}}\\
Remove coordinate at index in contour 0. See fifth form.
\item{\code{.r coords tagOrId add coordList}}\\
Add coordinates at the end of contour 0. See sixth form.
\end{description}
\end{blockindent}
\zinccmd{currentpart}{}
\begin{blockindent}
Returns a string specifying the item part over which the pointer is.
If the current item doesn't have parts or if the pointer is not over
an item (no item has the \ident{current} tag) the command return {\tt ""}.
The string can be either an integer describing a field index or the
name of a special part of the item. Consult each item description to
find out which part names can be reported.
\end{blockindent}
\zinccmd{cursor}{tagOrId index}
\begin{blockindent}
Set the position of the insertion cursor for the items described by
{\tt tagOrId} to be just before the character at {\tt index}. If
some of the items described by {\tt tagOrId} don't support an
insertion cursor, the command doesn't change them. The possible
values for {\tt index} are described in the \cmdref{index} command.
The command returns an empty string.
\end{blockindent}
\zinccmd{dchars}{tagOrId first ?last?}
\begin{blockindent}
Delete the character range defined by the parameters {\tt first} and
{\tt last} inclusive in all the items described by {\tt tagOrId}.
Items that doesn't support text indexing are skipped by the command.
If {\tt last} is not specified, the command deletes the character
located at {\tt first}. The command returns an empty string.
\end{blockindent}
\zinccmd{dtag}{tagOrId ?tagToDelete?}
\begin{blockindent}
Delete the tag {\tt tagToDelete} from the list of tags associated
with each item named by {\tt tagOrId}. If an item doesn't have
the tag then it is leaved unaffected. If {\tt tagToDelete} is
omitted, {\tt tagOrId} is used instead. The command returns an
empty string as result.
\end{blockindent}
\zinccmd{find}{searchCommand ?arg arg ...?}
\begin{blockindent}
This command returns the list of all items selected by {\tt searchCommand}
and the {\tt args}. See the \cmdref{addtag} command for an explanation of
{\tt searchCommand} and the various {\tt args}. The items are sorted in
drawing order, topmost first.
\end{blockindent}
\zinccmd{fit}{coordList error}
\begin{blockindent}
This command fits a sequence of Bezier segments on the curve described
by the vertices in {\tt coordList} and returns a list of vertices describing
the control points for the generated segments. All the points on the fitted
segments will be within {\tt error} distance from the given curve.
{\tt coordList} should contain a pair number of coordinates in x, y order.
The returned control point list consists of four control points per Bezier
segment with two consecutive segments sharing their last/first control point.
The control points are in x, y order and can be used to create or change a
Bezier item.
\end{blockindent}
\zinccmd{focus}{focus ?tagOrId?}
\begin{blockindent}
Set the keyboard focus to the item describe by {\tt tagOrId}. If {\tt tagOrId}
describe more than one item, the first item in display list order that supports
an insertion cursor is used. If no such item exists, the command has no effect.
If {\tt tagOrId} is an empty string the focus is reset and no item has the focus.
If {\tt tagOrId} is not specified, the command returns the id of the item
with the focus or an empty string if no item has the focus.
When the focus has been set to an item, the item will display an insertion cursor
and the keyboard events will be directed to that item. The widget receive keyboards
events only if it has the window focus. It may be necessary to use the Tk focus
command to force the focus to the widget window.
\end{blockindent}
\zinccmd{gettags}{tagOrId}
\begin{blockindent}
This command returns the list of all the tags associated with
the item specified by {\tt tagOrId}. If more than one item is
named by {\tt tagOrId}, then the topmost in display list order
is used to return the result. If no item is named by {\tt tagOrId},
then the empty list is returned.
\end{blockindent}
\zinccmd{group}{tagOrId}
\begin{blockindent}
Returns the group containing the item described by {\tt tagOrId}.
If more than one item is named by {\tt tagOrId}, then the topmost
in display list order is used to return the result.
\end{blockindent}
\zinccmd{hasanchors}{tagOrId}
\begin{blockindent}
This command returns a boolean telling if the item specified by
{\tt tagOrId} supports anchors. If more than one item is named by
{\tt tagOrId}, then the topmost in display list order is used to
return the result. If no items are named by {\tt tagOrId}, an error
is raised.
\end{blockindent}
\zinccmd{hasfields}{tagOrId}
\begin{blockindent}
This command returns a boolean telling if the item specified by
{\tt tagOrId} supports fields. If more than one item is named by
{\tt tagOrId}, then the topmost in display list order is used to
return the result. If no items are named by {\tt tagOrId}, an error
is raised.
\end{blockindent}
\zinccmd{hastag}{tagOrId tag}
\begin{blockindent}
This command returns a boolean telling if the item specified by
{\tt tagOrId} has the specified tag. If more than one item is
named by {\tt tagOrId}, then the topmost in display list order
is used to return the result. If no items are named by {\tt tagOrId},
an error is raised.
\end{blockindent}
\zinccmd{index}{tagOrId index}
\begin{blockindent}
This command returns a number which is the numerical index in the item
described by {\tt tagOrId} corresponding to {\tt index}. {\tt index}
should be a textual description of a text index that can have the
following forms:
\begin{description}
\item{number} This should be an integer giving the character position
within the text of the item. The indices are zero based. A number
less than zero is treated as zero and a number greater than the
text length is rounded to the text length. A number equal to the
text length refers to the position past the last character in the
text.
\item{end} Refers to the position past the last character in the
text. This is the same as specifying a number equal to the text
length.
\item{insert} Refers to the character just before the insertion
cursor in the item.
\item{sel.first} Refers to the first character of the selection in
the item. If the selection is not in the item, this form returns
an error.
\item{sel.last}Refers to the last character of the selection in
the item. If the selection is not in the item, this form returns
an error.
\item{@x,y} Refers to the character at the point given by x and y,
x and y are interpreted as device coordinates. If the point lies
outside of the area corvered by the item, they refer to the first
or last character in the line that is closest to the point.
\end{description}
The command return a value between 0 and the number of character in
the item. If {\tt tagOrId} describe more than one item the index is
processed in the first item supporting text indexing in display list
order.
\end{blockindent}
\zinccmd{insert}{insert tagOrId before string}
\begin{blockindent}
This command inserts {\tt string} in each item described by {\tt tagOrId}
just before the text position described by {\tt before}. The possible
values for {\tt before} are described in the \cmdref{index} command.
Items that doesn't support text indexing are skipped by the command.
The command returns an empty string.
\end{blockindent}
\zinccmd{itemcget}{tagOrId ?field? attr}
\begin{blockindent}
Returns the current value of the attribute given by {\tt attr} for
the item named by {\tt tagOrId}. If {\tt tagOrId} name more than
one item, the topmost in display list order is used. If {\tt field} is
given, it must be a valid field index for the item or an error will be
reported. If a field index is given, the command will interpret {\tt attr}
as a field attribute (see \objectref{field}), otherwise it will be interpreted
as an item attribute (see the chapter \conceptref{Item types}{items}).
If the attribute is not available for the field or item type, an error is
reported.
\end{blockindent}
\zinccmd{itemconfigure}{tagOrId ?field? ?attr? ?value? ?attr value ...?}
\begin{blockindent}
Query or modify the attributes of an item or field. If no attribute
is given, returns a list of lists describing all the supported attributes.
If a single attribute is specified without a value, the command returns
a list describing the named attribute. Each attribute is described by a
list with the following content: the attribute name, the attribute type,
a boolean telling if the attribute is read-only, an empty string, and
the current value of the attribute. In the two querying forms of the
command the topmost item described by {\tt tagOrId} is used.
If at least one attribute - value pair is given, then the corresponding
attributes are changed for all the items described by {\tt tagOrId} and
the command return an empty string.
If {\tt field} is given, it must be a valid field index for the item or
an error will be reported. If a field index is given, the command will
interpret the given attributes as field attributes, otherwise they will
be interpreted as item attributes.
\end{blockindent}
\zinccmd{lower}{tagOrId ?belowThis?}
\begin{blockindent}
Reorder all the items given by {\tt tagOrId} so that they will be
under the item given by {\tt belowThis}. If {\tt tagOrId} name more
than one item, their relative order will be preserved. If
{\tt tagOrId} doesn't name an item, an error is raised. If
{\tt belowThis} name more than one item, the bottom most them is used.
If {\tt belowThis} doesn't name an item, an error is raised. If
{\tt belowThis} is omitted the items are put at the bottom most
position of their respective groups. The command ignore all items named
by {\tt tagOrId} that are not in the same group than {\tt belowThis} or,
if not specified, in the same group than the first item named by
{\tt tagOrId}. The command returns an empty string.
As a side affect of this command, the \ident{priority} attribute of
all the reordered items is ajusted to match the priority of the
{\tt belowThis} item (or the priority of the bottom most item).
\end{blockindent}
\zinccmd{monitor}{?onOff?}
\begin{blockindent}
This command controls the gathering of performance data. The data
gathering is inited and turned on when the command is called with
a boolean true parameter. The gathering is stopped if the command
is called with a boolean false parameter. If the command is called
with no parameters or with a boolean false parameter, it returns a
string describing the currently collected data. The other form of
the command returns the empty string.
\end{blockindent}
\zinccmd{numparts}{tagOrId}
\begin{blockindent}
This command tells how many private parts are available for event bindings
in the item specified by {\tt tagOrId}. If more than one item is named
by {\tt tagOrId}, the topmost in display list order is used to return the
result. If no items are named by {\tt tagOrId}, an error is raised.
\end{blockindent}
\zinccmd{postscript}{}
\begin{blockindent}
Not yet implemented.
\end{blockindent}
\zinccmd{raise}{tagOrId ?aboveThis?}
\begin{blockindent}
Reorder all the items given by {\tt tagOrId} so that they will be
above the item given by {\tt aboveThis}. If {\tt tagOrId} name more
than one item, their relative order will be preserved. If
{\tt tagOrId} doesn't name an item, an error is raised. If
{\tt aboveThis} name more than one item, the topmost in display
list order is used. If {\tt aboveThis} doesn't name an item, an error
is raised. If {\tt aboveThis} is omitted the items are put at the top most
position of their respective groups. The command ignore all items named
by {\tt tagOrId} that are not in the same group than {\tt aboveThis} or,
if not specified, in the same group than the first item named by
{\tt tagOrId}. The command returns an empty string.
As a side affect of this command, the \ident{priority} attribute of
all the reordered items is ajusted to match the priority of the
{\tt aboveThis} item (or the priority of the top most item).
\end{blockindent}
\zinccmd{remove}{tagOrId ?tagOrId ...?}
\begin{blockindent}
Delete all the items named by each {\tt tagOrId}. The
command returns an empty string.
\end{blockindent}
\zinccmd{rotate}{tagOrId angle ?centerX centerY?}
\begin{blockindent}
Add a rotation to the items or the transform described by
{\tt tagOrId}. If {\tt tagOrId} describe a named transform
then this transform is used to do the operation. If {\tt tagOrId}
describe more than one item then all the items are affected by
the opration. If {\tt tagOrId} describe neither a named transform
nor an item, an error is raised. The angle is given in radians.
The optional parameters describe the center of rotation, which
defaults to the origin.
\end{blockindent}
\zinccmd{scale}{tagOrId xFactor yFactor}
\begin{blockindent}
Add a scale factor to the items or the transform described by
{\tt tagOrId}. If {\tt tagOrId} describe a named transform
then this transform is used to do the operation. If {\tt tagOrId}
describe more than one item then all the items are affected by
the opration. If {\tt tagOrId} describe neither a named transform
nor an item, an error is raised. A separate factor is specified for
X and Y.
\end{blockindent}
\zinccmd{select}{option ?tagOrId? ?arg?}
\begin{blockindent}
Manipulates the selection as requested by {\tt option}. {\tt tagOrId}
Describe the target item. This item must support text indexing and
selection. If more than one item is referred to by {\tt tagOrId}, the
first in display list order that support both text indexing and selection
will be used. Some forms of the command include an {\tt index} parameter,
this parameter describe a textual position within the item and should
be a valid index as described in the \cmdref{index} command.
The valid forms of the command are :
\begin{description}
\item{\code{.r select adjust tagOrId index}} \\
Adjust the end of the selection in {\tt tagOrId} that is nearest to
the character given by {\tt index} so that it is at {\tt index}. The
other end of the selection is made the anchor for future select to
commands. If the selection is not currently in {\tt tagOrId}, this
command behaves as the select to command. The command returns an empty
string.
\item{\code{.r select clear}} \\
Clear the selection if it is in the widget. If the selection is not
in the widget, the command has no effect. Return an empty string.
\item{\code{.r select from tagOrId index}} \\
Set the selection anchor point for the widget to be just before
the character given by {\tt index} in the item described by
{\tt tagOrId}. The command has no effect on the selection, it
sets one end of the selection so that future select to can actually
set the selection. The command returns an empty string.
\item{\code{.r select item}} \\
Returns the id of the selected item, if the selection is in an item
on this widget. Otherwise the command returns an empty string.
\item{\code{.r select to tagOrId index}} \\
Set the selection to be the characters that lies between the selection
anchor and {\tt index} in the item described by {\tt tagOrId}. The
selection includes the character given by {\tt index} and includes the
character given by the anchor point if {\tt index} is greater or
equal to the anchor point. The anchor point is set by the most recent
select adjust or select from command issued for this widget. If the
selection anchor point for the widget is not currently in {\tt tagOrId},
it is set to the character given by index. The command returns an empty
string.
\end{description}
\end{blockindent}
\zinccmd{smooth}{coordList}
\begin{blockindent}
This command computes a sequence of Bezier segments in order to smooth the
curve described by the vertices in {\tt coordList} and returns a list of
vertices describing the control points for the generated segments.
{\tt coordList} should contain a pair number of coordinates in x, y order.
The returned control point list consists of four control points per Bezier
segment with two consecutive segments sharing their last/first control point.
The control points are in x, y order and can be used to create or change a
Bezier item.
\end{blockindent}
\zinccmd{tapply}{}
\begin{blockindent}
Not yet implemented.
\end{blockindent}
\zinccmd{tdelete}{tName}
\begin{blockindent}
Destroy a named transform. If the given name is not found
among the named transforms, an error is raised.
\end{blockindent}
\zinccmd{transform}{?tagOrIdFrom? tagOrIdTo coordList}
\begin{blockindent}
This command returns a list of coordinates obtained by transforming
the coordinates given in {\tt coordList} from the coordinate space
of the transform or item described by {\tt tagOrIdFrom} to the
coordinate space of the transform or item described by {\tt tagOrIdTo}.
If {\tt tagOrIdFrom} is omitted it defaults to the device coordinate
space. If either {\tt tagOrId} describe more than one item, the topmost
in display list order is used. If {\tt tagOrId} doesn't describe
either a transform or an item, an error is raised.
\end{blockindent}
\zinccmd{translate}{tagOrId xAmount yAmount}
\begin{blockindent}
Add a translation to the items or the transform described by
{\tt tagOrId}. If {\tt tagOrId} describe a named transform
then this transform is used to do the operation. If {\tt tagOrId}
describe more than one item then all the items are affected by
the opration. If {\tt tagOrId} describe neither a named transform
nor an item, an error is raised. A separate value is specified for
X and Y.
\end{blockindent}
\zinccmd{treset}{tagOrId}
\begin{blockindent}
Set the named transform or the transform for the items described
by {\tt tagOrId} to identity. If {\tt tagOrId} describe neither
a named transform nor an item, an error is raised.
\end{blockindent}
\zinccmd{trestore}{tagOrId tName}
\begin{blockindent}
Set the transform for the items described by {\tt tagOrId} to the
transform named by {\tt tName}. If {\tt tagOrId} doesn't describe
any item or if the transform named {\tt tName} doesn't exist, an
error is raised.
\end{blockindent}
\zinccmd{tsave}{tagOrId tName}
\begin{blockindent}
Create (or reset) a transform associated with the name {\tt tName}
which has for initial value the transform associated with the item
{\tt tagOrId}. If {\tt tagOrId} describe more than one item, the
topmost in display list order is used. If {\tt tagOrId} doesn't describe
any item, an error is raised. If {\tt tName} already exists, the
transform is set to the new value. This command is the only way to
create a named transform.
\end{blockindent}
\zinccmd{type}{tagOrId}
\begin{blockindent}
This command returns the type of the item specified by {\tt tagOrId}.
If more than one item is named by {\tt tagOrId}, then the type of
the topmost item in display list order is returned.
If no items are named by {\tt tagOrId}, an error is raised.
\end{blockindent}
\zinccmd{vertexat}{tagOrId x y}
\begin{blockindent}
Return a list of values describing the vertex and edge closest to the
device coordinates {\tt x} and {\tt y} in the item described by {\tt tagOrId}.
If {\tt tagOrId} describes more than one item, the first item in display list
order that supports vertex picking is used. The list consists of the index
of the contour containing the returned vertices, the index of the
closest vertex and the index of a vertex next to the closest vertex that
identify the closest edge (located between the two returned vertices).
\end{blockindent}
\chapter{Attribute types}
\attrtype{alignment}
\begin{blockindent}
Specifies the horizontal alignment of an entity.
The legal values are: {\tt left}, {\tt right}, {\tt center}.
\end{blockindent}
\attrtype{anchor}
\begin{blockindent}
Specifies one of the nine caracteristic points of a rectangle
or bounding box that will be used to position the object.
These points include the four corners the four edge centers
and the center of the rectangle. The possible values are: {\tt nw},
{\tt n}, {\tt ne}, {\tt e}, {\tt se}, {\tt s}, {\tt sw}, {\tt w},
{\tt center}.
\end{blockindent}
\attrtype{angle}
\begin{blockindent}
Specifies an angle in degrees, the value must be an integer from
0 to 360 inclusive.
\end{blockindent}
\attrtype{autoalignment}
\begin{blockindent}
Specifies the horizontal alignments that should be used for track
or way point fields depending on the label position relative to
the position of the item. The attribute may have two forms: a
single dash {\tt -} means turning of the automatic alignment feature
for the field; The other form consists in three letters which
describe in order: the alignment to be used when the label is to
the left of the item position, above or below the item position and
to the right of the item position. The possible values for each
letter is: {\tt l} for left alignment, {\tt c} for center
alignment and {\tt r} for right alignment. Here is an example:
{\tt rll} means right align the field if the label is on the
left side of the item, and left align if the label is above, below
or on the right of the item.
\end{blockindent}
\attrtype{bitmap}
\begin{blockindent}
This should be a string naming a valid Tk bitmap. The bitmap should
be known to Tk prior to its use. Zinc registers a set of bitmaps that
can be used for any bitmap valued attribute (see \ref{builtinbitmaps}).
Extensions to Tk are available to create or manipulate bitmaps from a
script. The value may also name a file containing a valid X11 bitmap
description. The syntax in this cas is {\tt @filename}.
\end{blockindent}
\attrtype{bitmaplist}
\begin{blockindent}
This is an extension of the \ident{bitmap} attribute type. It describes
a list of bitmaps that will be the value of the attribute.
\end{blockindent}
\attrtype{boolean}
\begin{blockindent}
This is the description of a standard Tcl boolean value. The possible
values are {\tt 0}, {\tt false}, {\tt no} or {\tt off} for the false
value and {\tt 1}, {\tt true}, {\tt yes} or {\tt on} for the true value.
\end{blockindent}
\attrtype{capstyle}
\begin{blockindent}
This the description of a line cap. The possible values are {\tt butt},
{\tt projecting} and {\tt round}.
\end{blockindent}
\attrtype{color}
\begin{blockindent}
This is a string that describes a color. The description may have one of
two forms, a colorname such as {\tt green} or {\tt LemonChiffon} or an
rgb specification in one of the following formats, {\tt \#rgb}, {\tt \#rrggbb},
{\tt \#rrrgggbbb} or {\tt \#rrrrggggbbbb}. If less than four digits are provided
for a color component, they represent the most significant bits of the
component. For example {\tt \#3a7} is equivalent to {\tt \#3000a0007000}.
\end{blockindent}
\attrtype{dimension}
\begin{blockindent}
This is a string that represent a screen distance which will be converted
into a distance in pixels. The string consists in a floating point signed
number optionally followed by a character specifying the unit. The character
can be {\tt c} for centimeters, {\tt i} for inches, {\tt m} for millimeters,
{\tt p} for printer's points (1/72 inch) or nothing for pixels.
\end{blockindent}
\attrtype{edgelist}
\begin{blockindent}
This is a list describing the edges of a border that should be considered
for processing (e.g for drawing). The possible values are {\tt left},
{\tt right}, {\tt top}, {\tt bottom}, {\tt contour}, {\tt oblique} and
{\tt counteroblique}. The {\tt contour} value is the same as the
{\tt "left top right bottom"} list. The {\tt oblique} and {\tt counteroblique}
values describe diagonal segments from top-left to bottom-right and from
top-right to bottom-left respectively.
\end{blockindent}
\attrtype{font}
\begin{blockindent}
This is a string describing a font. For an exhaustive description of
what is legal as a font description, refer to the Tk \ident{font}
command man page. Just to mention to popular methods, it is possible to
specify a font by it's X11 font name or by a list whose elements are the
font family, the font size and then zero or more styles including {\tt normal},
{\tt bold}, {\tt roman}, {\tt italic}, {\tt underline}, {\tt overstrike}.
\end{blockindent}
\attrtype{gradientcolor}
\begin{blockindent}
This is a string describing a color span to be used for example to fill
a surface. The string consists of the first color of the span, the last
color of the span and the number of steps that it should take to go from
the first color to the last. The three elements are sperated by spaces.
The two colors can take any form legal in a color context (see the
\ident{color} attribute type). The number of steps should be a non negative
integer. The intermediate colors are generated by linear interpolation
between the two specified colors. A simplified form consists in only one
color, this is useful when no gradient filling is needed. When the full
description is used and only one color is used by the item (e.g when
filling with a solid color) then the span median color is used.
\end{blockindent}
\attrtype{gradientgeometry}
\begin{blockindent}
This is a string describing the geometry that should be used to fill a
surface with a color gradient. The string should have one of the forms
{\tt threshold1-threshold2/angle}, {\tt threshold/angle},
{\tt threshold1-threshold2} or {\tt threshold}. The threshold values
are a percentage along the gradient axis where the mid color should
be reached (first threshold) or leaved (second threshold). The angle
is an unsigned value in degrees specifying the gradient axis orientation.
\end{blockindent}
\attrtype{image}
\begin{blockindent}
This should be the name of a previously registered Tk image. In pure
Tk only GIF, PPM and bitmap formats are available as source for images.
With the Img extension many others popular formats are added including
JPEG, XPM and PNG.
\end{blockindent}
\attrtype{integer}
\begin{blockindent}
Describes a signed integer value.
\end{blockindent}
\attrtype{item}
\begin{blockindent}
Describes an item id or a tag. If a tag is provided an item will be
searched for the tag and the first matching in display list order will
be used.
\end{blockindent}
\attrtype{joinstyle}
\begin{blockindent}
Describes a join style. The possible values are {\tt bevel}, {\tt miter}
and {\tt round}.
\end{blockindent}
\attrtype{labelformat}
\begin{blockindent}
The new format is as follow. Parameters between [] are
optional and take default values when omitted. The spaces can appear
between blocks but not inside.
\verb+[WidthxHeight] [field0Spec] [field1Spec] [fieldnSpec]+\\
Width and Height set the size of the clipping box surrounding
the label. If it is not specified, there will be no clipping.
It it is specified alone it is the size of the only displayed
field (0).
fieldSpec is:
\verb+sChar fieldWidth sChar fieldHeight [pChar fieldX pChar fieldY]+.
Each field description refers to the field of same index in the field
array.
If \verb+sChar+ is \verb+'x'+, the dimension is in pixel. If \verb+sChar+ is
\verb+'f'+, the dimension is in percentage of the mean width/height of a
character (in the field font). If \verb+sChar+ is \verb+'i'+, the dimension
is in percentage of the size of the image in the field. If \verb+sChar+ is
\verb+'a'+, the dimension is automatically adjusted to match the field's
content plus the given value in pixels. If \verb+sChar+ is \verb+'l'+,
the dimension is automatically adjusted to match the global size of the
label (not counting fields with \verb+'l'+ size specs). The positional
parameter is not used with this size specification (always 0) and it is not
possible to reference the field in another field spec.
If \verb+pChar+ is \verb-'+'- the position is in pixel (possibly negative).
If it is \verb+'<'+ the position is the index of the field at the left/top
of which the current field should be attached. If it is \verb+'>'+ the
position is the index of the field at the right/bottom of which the current
field should be attached. If \verb+pChar+ is \verb+'^'+ the position is
the index of the field used to align the left/top border (left on left or
top on top). If \verb+pChar+ is \verb+'$'+ the %$ position is the index
of the field used to align the right/bottom border (right on right or
bottom on bottom).
The positional parameters can be omitted if there is only one field.
\end{blockindent}
\attrtype{leaderanchors}
\begin{blockindent}
Describe where to attach the label leader on the label. These are not
to be confused with the regular rectangular anchors.
The format is: lChar leftLeaderAnchor [lChar rightLeaderAnchor]
If lChar is a '|', leftLeaderAnchor and rightLeaderAnchor
are the indices of the field that serve to anchor the label's leader. More
specifically the bottom right corner is used when leftLeaderAnchor is active
and the bottom left corner is used when rightLeaderAnchor is active.
If lChar is '\%', leftLeaderAnchor and rightLeaderAnchor should be specified
as widthPercentxheightPercent, each value being a percentage (between 1 and 100)
of the width/height of the label bounding box. If rightLeaderAnchor is not
specified it defaults to leftLeaderAnchor. If neither of them are specified, the
center of the label is used as an anchor.
\end{blockindent}
\attrtype{lineend}
\begin{blockindent}
Describe the shape of the arrow at the beginning or end of a path.
This is a list of three numbers describing the arrow shape in the
following order:
distance along the axis from neck to tip of the arrowhead,
distance from trailing points to tip and distance from outside
edge of the line to the trailing points (see canvas).
If an empty list is given, there is no arrow.
\end{blockindent}
\attrtype{lineshape}
\begin{blockindent}
Describes the shape of a path connecting two points. The possible
values are {\tt straight}, {\tt rightlightning}, {\tt leftlightning},
{\tt rightcorner}, {\tt leftcorner}, {\tt doublerightcorner} and
{\tt doubleleftcorner}.
\end{blockindent}
\attrtype{linestyle}
\begin{blockindent}
Describes the style of the dashes that should be used to draw a line.
The possible values are {\tt simple}, {\tt dashed}, {\tt mixed} and
{\tt dotted}.
\end{blockindent}
\attrtype{mapinfo}
\begin{blockindent}
This is the name of a previously registered mapinfo object
(see \ref{mapinfocmd}) that will define the lines, symbols,
texts an other graphical parts displayed in a map item.
\end{blockindent}
\attrtype{number}
\begin{blockindent}
This is floating point value. It can be optionally expressed in
exponent notation.
\end{blockindent}
\attrtype{position}
\begin{blockindent}
This is a list of two floating point values that describes a point
position or some two dimensional delta (used for example to describe
the speed vector of a track item).
\end{blockindent}
\attrtype{relief}
\begin{blockindent}
Describes a border relief. The possible values are {\tt flat}, {\tt groove},
{\tt raised}, {\tt ridge} and {\tt sunken}.
\end{blockindent}
\attrtype{string}
\begin{blockindent}
Just what its name implies, a string.
\end{blockindent}
\attrtype{taglist}
\begin{blockindent}
This should be a list of strings describing the tags that are set
for an item.
\end{blockindent}
\attrtype{window}
\begin{blockindent}
A string describing an X window id. This id can be returned by the
{\tt winfo id a-widget-path} command.
\end{blockindent}
\chapter{Labels, fields and label formats}
\concept{label}
\concept{labelformat}
\object{field}
Applicable attributes for fields:
\attribute{alignment}{alignment}{
The horizontal alignment of both the text and the image. The default value
is {\tt left}.}
\attribute{autoalignment}{autoalignment}{
The dynamic horizontal alignments used depending on the label orientation.
The default value is {\tt "-"} which means do not use dynamic alignment.}
\attribute{backcolor}{color}{
The field background color. The default value is the current value of the widget
option \ident{-foreground}.}
\attribute{border}{edgelist}{
The border description edge by edge. The border is a one pixel wide outline that
is drawn around the field outside the relief. Some border edges can be omitted,
this attribute describe the edges that should be displayed as part of the border.
The default value is {\tt ""}.}
\attribute{bordercolor}{color}{
The border color. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{color}{color}{
The text color. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{filled}{boolean}{
Specifies if the field background should be filled. The default value is
{\tt false}.}
\attribute{fillpattern}{bitmap}{
The fill pattern used when filling the background. This attribute is overrided
by the tile attribute. The default value is {\tt ""}.}
\attribute{font}{font}{
The text font. The default value is the current value of the widget option
\ident{-font}.}
\attribute{image}{image}{
An image to be displayed in the field. The image will be centered vertically
in the field. The default value is {\tt ""}.}
\attribute{relief}{relief}{
Specifies the relief to be drawn around the field, inside the border. The
default value is {\tt flat}.}
\attribute{reliefthickness}{dimension}{
Width of the relief drawn around the field. The default value is {\tt 0}
which means that no relief should be drawn around the field.}
\attribute{sensitive}{boolean}{
Specifies if the field should react to input events. The default value is
{\tt true}.}
\attribute{text}{string}{
A line of text to be displayed in the field. The text will be centered vertically
in the field. The default value is {\tt ""}.}
\attribute{tile}{image}{
Specifies an image that will be tiled over the field background is the field
is filled. This attribute has precedence over the \ident{fillpattern} attribute.
The default value is {\tt ""}.}
\attribute{visible}{boolean}{
Specifies if the field is displayed. The default value is {\tt true}.}
\chapter{Item types}
\concept{items}
This chapter introduces the item types that can be used in \ident{zinc}. Each
item type provides a set of options that may be used to query or change the
item behavior. Some item types cannot be used with some widget commands, or
use special parameters with some command. Those cases are noted in the description
of the item.
\section{Group items}
\object{group}
Applicable attributes for \ident{group}:
\attribute{atomic}{boolean}{Specifies if the group should report itself
or its components during a search or for binding related operations. This
attribute enable the use of a group as a single complex object build from
smaller parts. It is possible to search for this item or use it in bindings
without dealing with its smaller parts. The defaut value is {\tt false}.}
\attribute{clip}{item}{The item used to clip the children of the group. The shape
of this item define an area that is used as a clipping shape when drawing the
children of the group. Most items can be used here but notable exceptions are
the \ident{reticle} and \ident{map} items. The default value is {\tt ""} which
means that no clipping will be performed.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should be
composed with the local transform. The defaut value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The defaut value is {\tt true}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 6}.}
\attribute{sensitive}{boolean}{Specifies if the item and all its children should
react to events. The defaut value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item and all its children is
displayed. The defaut value is {\tt true}.}
\section{Track and WayPoint items}
\object{track}
Applicable attributes for \ident{track}:
\attribute{circlehistory}{boolean}{If set to true the track history will
be plotted as cricles otherwise it will be plotted as squares. The default
value is {\tt false}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{The item at the other end of the connection link.
The default value is {\tt ""} which means that no connection link will be drawn.}
\attribute{connectioncolor}{color}{The color of the connection link. The
default value is the current value of the widget option \ident{-foreground}.}
\attribute{connectionsensitive}{boolean}{Specifies if the connection link
is sensitive. The actual sensitivity is the logical and of this attribute and
of the item {\tt sensitive}{boolean} attribute. The default value is {\tt true}.}
\attribute{connectionstyle}{linestyle}{The line style of the connection link.
The default value is {\tt simple}.}
\attribute{connectionwidth}{dimension}{The width of the connection link. The
default value is {\tt 1}.}
\attribute{filledhistory}{boolean}{If set to true the track history will be
filled otherwise it will be outlined. The default value is {\tt true}.}
\attribute{filledmarker}{boolean}{If set to true the circular marker will be
filled otherwise it will be outlined. The default value is {\tt false}.}
\attribute{frozenlabel}{boolean}{Specifies if the label should be frozen at
its current location to prevent the anti overlapping system from moving it. The
default value is {\tt false}.}
\attribute{historycolor}{color}{The color of the track history. The default value
is the current value of the widget option \ident{-foreground}.}
\attribute{labelanchor}{anchor}{The anchor used in positionning the label. The
default value is {\tt center}.}
\attribute{labelangle}{angle}{The angle in degrees between the label anchor
and the normal to the speed vector. This attribute works with the {\tt labeldistance}
attribute to specify a position for the label anchor with respect to the item
origin. There is another alternative method for label positioning which is
implemented with the {\tt labeldx} and {\tt labeldy} methods. Simultaneous
use of the two methods should be done with care as there is no automatic update
of values from the {\tt labeldx}, {\tt labeldy} set to the {\tt labeldistance},
{\tt labelangle} set. The default value is {\tt 20}.}
\attribute{labeldistance}{dimension}{The minimum distance in pixels between
the track position and the label anchor. See the explanation of the {\tt labelangle}
attribute for some more details. The default value is 50.}
\attribute{labeldx}{dimension}{The X offset between the track position and the
label anchor. The default value is computed from the values in the {\tt labeldistance}
and {\tt labelangle} attributes.}
\attribute{labeldy}{dimension}{The Y offset between the track position and the label
anchor. The default value is computed from the values in the {\tt labeldistance} and
{\tt labelangle} attributes.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
value is {\tt ""} which means that no label will be displayed.}
\attribute{lastasfirst}{boolean}{If set to true, the last position in the
history will be drawn in the same color as the current position instead of
being drawn in the history color. The default value is {\tt false}.}
\attribute{leaderanchors}{leaderanchors}{The attachments of the leader on the
label side. The default value is {\tt ""} which means that both leader anchors are
at the label center.}
\attribute{leadercolor}{color}{The color of the label leader. The default value
is the current value of the widget option \ident{-foreground}.}
\attribute{leaderfirstend}{lineend}{Describe the arrow shape at the current position
end of the leader. The default value is {\tt ""}.}
\attribute{leaderlastend}{lineend}{Describe the arrow shape at the label end of
the leader. The default value is {\tt ""}.}
\attribute{leadersensitive}{boolean}{Specifies if the label leader is sensitive.
The actual sensitivity is the logical and of this attribute and of the item
{\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{leadershape}{lineshape}{The shape of the label leader. The default
value is {\tt straight}.}
\attribute{leaderstyle}{linestyle}{The line style of the label leader. The default
value is {\tt simple}.}
\attribute{leaderwidth}{dimension}{The width of the label leader. The default
value is {\tt 1}.}
\attribute{markercolor}{color}{The color of the circular marker. The default
value is the current value of the widget option \ident{-foreground}.}
\attribute{markerfillpattern}{bitmap}{The pattern to use when filling the
circular marker. The default value is {\tt ""}.}
\attribute{markersize}{number}{The (scale sensitive) size of the circular marker.
The default value is {\tt 0} which turn off the display of the marker.}
\attribute{markerstyle}{linestyle}{The line style of the marker outline. The
default value is {\tt simple}.}
\attribute{mixedhistory}{boolean}{If true the track history will be plotted
with dots every other positions. The default value is {\tt false}.}
\attribute{numfields}{integer}{Gives the number of fields available for the
label. This attribute is read only.}
\attribute{position}{position}{The current location of the track. The default
value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 5}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{speedvector}{position}{The speed vector $\Delta x$ and $\Delta y$
in unit / minute. The default value is {\tt "0 0"} which results in no speed vector
displayed.}
\attribute{speedvectorcolor}{color}{The color of the trck's speed vector. The
default value is the current value of the widget option \ident{-foreground}.}
\attribute{speedvectorsensitive}{boolean}{Specifies if the track's speed vector
is sensitive. The actual sensitivity is the logical and of this attribute and of
the item {\tt sensitive} attribute. The default value is {\tt true}. }
\attribute{symbol}{bitmap}{The symbol displayed at the current position. The
default value is {\tt AtcSymbol15}.}
\attribute{symbolcolor}{color}{The color of the symbol displayed at the current
position. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{symbolsensitive}{boolean}{Specifies if the current position's symbol
is sensitive to events. The actual sensitivity is the logical and of this attribute
and of the item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default value
is {\tt true}.}
\attribute{visiblehistorysize}{integer}{The number of past positions that should
be displayed. The default value is {\tt 6}.}
\object{waypoint}
Applicable attributes for \ident{waypoint}:
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}. }
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}. }
\attribute{connecteditem}{item}{The item at the other end of the connection link.
The default value is {\tt ""} which means that no connection link will be drawn.}
\attribute{connectioncolor}{color}{The color of the connection link. The default
value is the current value of the widget option \ident{-foreground}.}
\attribute{connectionsensitive}{boolean}{Specifies if the connection link is
sensitive. The actual sensitivity is the logical and of this attribute and of the
item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{connectionstyle}{linestyle}{The line style of the connection link.
The default value is {\tt simple}.}
\attribute{connectionwidth}{dimension}{The width of the connection link. The
default value is {\tt 1}.}
\attribute{filledmarker}{boolean}{If set to true the circular marker will be
filled otherwise it will be outlined. The default value is {\tt false}.}
\attribute{labelanchor}{anchor}{The anchor used in positionning the label. The
default value is {\tt center}.}
\attribute{labelangle}{angle}{The angle in degrees between the label anchor and
the normal to the speed vector. This attribute works with the {\tt labeldistance}
attribute to specify a position for the label anchor with respect to the item origin.
There is another alternative method for label positioning which is implemented with
the {\tt labeldx} and {\tt labeldy} methods. Simultaneous use of the two methods
should be done with care as there is no automatic update of values from the
{\tt labeldx}, {\tt labeldy} set to the {\tt labeldistance}, {\tt labelangle} set.
The default value is {\tt 20}.}
\attribute{labeldistance}{dimension}{The minimum distance in pixels between the
way point position and the label anchor. See the explanation of the {\tt labelangle}
attribute for some more details. The default value is 50.}
\attribute{labeldx}{dimension}{The X offset between the way point position and
the label anchor. The default value is computed from the values in the
{\tt labeldistance} and {\tt labelangle} attributes.}
\attribute{labeldy}{dimension}{The Y offset between the way point position and
the label anchor. The default value is computed from the values in the
{\tt labeldistance} and {\tt labelangle} attributes.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
value is {\tt ""} which means that no label will be displayed.}
\attribute{leaderanchors}{leaderanchors}{The attachments of the leader on the
label side. The default value is {\tt ""} which means that both leader anchors are
at the label center.}
\attribute{leadercolor}{color}{The color of the label leader. The default value
is the current value of the widget option \ident{-foreground}.}
\attribute{leaderfirstend}{lineend}{Describe the arrow shape at the current position
end of the leader. The default value is {\tt ""}.}
\attribute{leaderlastend}{lineend}{Describe the arrow shape at the label end of
the leader. The default value is {\tt ""}.}
\attribute{leadersensitive}{boolean}{Specifies if the label leader is sensitive.
The actual sensitivity is the logical and of this attribute and of the item
{\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{leadershape}{lineshape}{The shape of the label leader. The default
value is {\tt straight}.}
\attribute{leaderstyle}{linestyle}{The line style of the label leader. The
default value is {\tt simple}.}
\attribute{leaderwidth}{dimension}{The width of the label leader. The default
value is {\tt 1}.}
\attribute{markercolor}{color}{The color of the circular marker. The default
value is the current value of the widget option \ident{-foreground}.}
\attribute{markerfillpattern}{bitmap}{The pattern to use when filling the circular
marker. The default value is {\tt ""}.}
\attribute{markersize}{number}{The (scale sensitive) size of the circular marker.
The default value is {\tt 0} which turn off the display of the marker.}
\attribute{markerstyle}{linestyle}{The line style of the marker outline. The
default value is {\tt simple}.}
\attribute{numfields}{integer}{Gives the number of fields available for the label.
This attribute is read only.}
\attribute{position}{position}{The current location of the way point. The default
value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 4}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{symbol}{bitmap}{The symbol displayed at the current position. The
default value is {\tt AtcSymbol15}.}
\attribute{symbolcolor}{color}{The color of the symbol displayed at the current
position. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{symbolsensitive}{boolean}{Specifies if the current position's symbol
is sensitive to events. The actual sensitivity is the logical and of this attribute
and of the item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Tabular items}
\object{tabular}
Applicable attributes for \ident{tabular}:
\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
value is {\tt nw}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this item
is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
The default value is {\tt sw}.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
value is {\tt ""} which means that nothing will be displayed.}
\attribute{numfields}{integer}{Gives the number of fields available for the
label. This attribute is read only.}
\attribute{position}{position}{The item's position relative to the anchor
(if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 3}. }
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Text items}
\object{text}
Applicable attributes for \ident{text}:
\attribute{alignment}{alignment}{Specifies the horizontal alignment of the
lines in the item. The default value is {\tt left}.}
\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
value is {\tt nw}.}
\attribute{color}{color}{Specifies the color for drawing the text characters,
the overstrike and underline lines. The default value is the current value
of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this item
is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
The default value is {\tt sw}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern used to draw the text
characters, the overstrike and underline lines. The default value is {\tt ""}.}
\attribute{font}{font}{Specifies the font for the text. The default value is
the current value of the widget option \ident{-font}.}
\attribute{overstriked}{boolean}{If true, a thin line will be drawn horizontally
across the text characters. The default value is {\tt false}.}
\attribute{position}{position}{The item's position relative to the anchor
(if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{spacing}{dimension}{Specifies a pixel value that will be added to
the inter-line spacing specified in the font. The value can be positive to
increase the spacing or negative to reduce it. The default value is {\tt 0}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{text}{string}{Specifies the text characters. Newline characters can
be embedded to force line ends. The default value is {\tt ""}.}
\attribute{underlined}{boolean}{If true, a thin line will be drawn under the
text characters. The default value is {\tt false}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\attribute{width}{dimension}{Specifies the maximum pixel width of the text, a
line break will be automatically inserted at the closest character position to
match this constraint. If the value is zero, the width is not under the item
control and line breaks must be inserted in the text to have multiple lines.
The default value is {\tt 0}.}
\section{Icon items}
\object{icon}
Applicable attributes for \ident{icon}:
\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
value is {\tt nw}.}
\attribute{color}{color}{Specifies the fill color used for drawing the bitmap.
The default value is the current value of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
be composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this
item is placed}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
The default value is {\tt sw}.}
\attribute{image}{image}{Specifies a Tk image that will be displayed by the item.
The image may have a mask (depend on the image format) that clip some parts. This
option has precedence over the {\tt mask} option if both are specified. The
default value is {\tt ""}.}
\attribute{mask}{bitmap}{Specifies a Tk bitmap that will be displayed by the
item. The bitmap is filled with the color specified with the {\tt color} option.
This option is inactive if an image has been specified with the {\tt image} option.}
\attribute{position}{position}{The item's position relative to the anchor (if
no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Reticle items}
\object{reticle}
Applicable attributes for \ident{reticle}:
\attribute{brightlinecolor}{color}{This is the color of the highlighted
circles. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{brightlinestyle}{linestyle}{This is the line style of the highlighted
circles. The default value is {\tt simple}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{firstradius}{number}{This is the radius of the innermost circle of
the reticle. The default value is {\tt 80}.}
\attribute{linecolor}{color}{This is the color of the regular (not highlighted)
circles. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{linestyle}{linestyle}{This is the line style of the regular (not
highlighted) circles. The default value is {\tt simple}.}
\attribute{numcircles}{integer}{Specifies how many circles should be drawn.
The default value is {\tt -1} which means draw as many circles as needed to
encompass the current widget window. This does not take into account any possible
clipping that can mask part of the reticle. The idea behind this trick is to draw
an infinite reticle that is optimized for the current scale.}
\attribute{period}{integer}{Specifies the recurrence of the bright circles over
the regulars. The default value is {\tt 5} which means that a bright circle is
drawn then 4 regulars, etc.}
\attribute{position}{position}{Location of the center of the reticle. The default
value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt false} as the item cannot handle events.}
\attribute{stepsize}{number}{The (scale sensitive) size of the step between two
consecutive circles. The default value is {\tt 80}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Map items}
\object{map}
Applicable attributes for \ident{map}:
\attribute{color}{color}{Specifies the color usedd to draw or fill the map. The
texts and symbols that are part of the map are also drawn in this color.
The default value is the current value of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{filled}{boolean}{If set to true the map wil be filled otherwise it
will be drawn as thin lines. The default is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to be used when filling
the map. The value should be a legal Tk bitmap. The default value is {\tt "}.}
\attribute{font}{font}{Specifies the font that will be used to drawn the texts of
the map. The default value is the current value of the widget option -maptextfont.}
\attribute{mapinfo}{mapinfo}{Specifies the lines, texts, symbols and other
various graphical components that should be displayed by the map item. All these
graphical components will share the graphical attributes (color, font, etc) of
the item and its coordinate system. The default value is {\tt ""} which means
that nothing will be displayed by the map.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 1}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt false} as the item cannot handle events.}
\attribute{symbols}{bitmaplist}{}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Rectangle items}
\object{rectangle}
Items of type \ident{rectangle} display a rectangular shape, optionally
filled. The rectangle is described by its bottom-left and top-right corners.
It is possible to use this item as a clip item for its group. It is also
possible to use the rectangle in a \ident{contour} command to build a complex
shape in a \ident{curve} item. The two points describing the rectangle
can be read and modified with the \ident{coords} command.
Applicable attributes for \ident{rectangle}:
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
the rectangle if requested by the \ident{filled} attribute. The default value is a
one color gradient based on the current value of the widget option \ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
item. The default value is {\tt ""}.}
\attribute{gradient}{gradientgeometry}{Specifies the type and geometry of the
gradient that should be drawn to fill the item. This will be done only if filling is
requested by the \ident{filled} attribute. The default value is {\tt ""} which means
no gradient geometry, fill with solid color. When a value other than the default is
specified, this attribute has priority over the \ident{tile} and \ident{fillpattern}
attributes.}
\attribute{linecolor}{color}{Specifies the color that will be used to draw
the item outline. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
scalable). The default value is {\tt 1}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the rectangle
outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
tiles. This will be done only if filling is requested by the \ident{filled} attribute.
This attribute has priority over the \ident{gradient} attribute when no gradient is
specified (paint solid) and the \ident{fillpattern} attribute. The default value is
{\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Arc items}
\object{arc}
Items of type \ident{arc} display an oval section, optionally filled,
delimited by two angles. The oval is described by its enclosing rectangle.
The arc can be closed either by a straight line joining its end points
or by two segments going throught the center to form a pie-slice.
It is possible to use this item as a clip item for its group, the clip
shape will be the polygon obtained by closing the arc. It is also possible
to use this polygon in a \ident{contour} command to build a complex shape
in a \ident{curve} item. The two points describing the enclosing rectangle
can be read and modified with the \ident{coords} command.
Applicable attributes for \ident{arc}:
\attribute{closed}{boolean}{Specifies if the outline of the arc should be
closed. This is only pertinent if the arc extent is less than 360 degrees.
The default value is {\tt false}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{extent}{angle}{Specifies the angular extent of the arc relative to the
start angle. The angle is expressed in degrees in the trigonometric system. The
default value is {\tt 360}.}
\attribute{fillcolor}{gradientcolor}{ Specifies the color that will be used to fill
the arc if requested by the \ident{filled} attribute. The default value is a
one color gradient based on the current value of the widget option
\ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start end of
the arc. This attribute is applicable only if the item is not closed and not filled.
The default value is {\tt ""}.}
\attribute{gradient}{gradientgeometry}{Specifies the type and geometry of the
gradient that should be drawn to fill the item. This will be done only if filling is
requested by the \ident{filled} attribute. The default value is {\tt ""} which means
no gradient geometry, fill with solid color. When a value other than the default is
specified, this attribute has priority over the \ident{tile} and \ident{fillpattern}
attributes.}
\attribute{lastend}{lineend}{Describe the arrow shape at the extent end of
the arc. This attribute is applicable only if the item is not closed and not filled.
The default value is {\tt ""}.}
\attribute{linecolor}{color}{Specifies the color that will be used to draw
the item outline. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
scalable). The default value is {\tt 1}.}
\attribute{pieslice}{boolean}{This attribute tells how to draw an arc whose
extent is less than 360 degrees. If this attribute is true the arc open end
will be drawn as a pie slice otherwise it will be drawn as a chord. The default
value is {\tt false}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{startangle}{angle}{Specifies the arc starting angle. The angle is
expressed in degrees in the trigonometric system. The default value is {\tt 0}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
tiles. This will be done only if filling is requested by the \ident{filled} attribute.
This attribute has priority over the \ident{gradient} attribute when no gradient is
specified (paint solid) and the \ident{fillpattern} attribute. The default value is
{\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Curve items}
\object{curve}
Items of type \ident{curve} display a path of line segments connected by their
end points. It is possible to build curve items with more than one path
to describe complex shapes with the \ident{contour} command. This command can be
used to perform boolean operations between a curve and almost any other item
available in \ident{zinc} including another curve. The polygon delimited by the
path can optionally be filled.
It is possible to use this item as a clip item for its group, the clip shape will
be the polygon obtained by closing the path. The vertices can be read, modified,
added or removed with the \ident{coords} command.
Applicable attributes for \ident{curve}:
\attribute{capstyle}{capstyle}{Specifies the form of the outline ends. This
attribute is only applicable if the curve is not closed and the outline relief is
flat. The default value is {\tt round}.}
\attribute{closed}{boolean}{Specifies if the curve outline should be drawn
between the first and last vertex or not. The default is {\tt true}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
be composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
the curve if requested by the \ident{filled} attribute. The default value is a
one color gradient based on the current value of the widget option
\ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start of the curve.
This attribute is applicable only if the item is not closed, not filled and
the relief of the outline is flat. The default value is {\tt ""}.}
\attribute{gradient}{gradientgeometry}{Specifies the type and geometry of the
gradient that should be drawn to fill the item. This will be done only if filling is
requested by the \ident{filled} attribute. The default value is {\tt ""} which means
no gradient geometry, fill with solid color. When a value other than the default is
specified, this attribute has priority over the \ident{tile} and \ident{fillpattern}
attributes.}
\attribute{joinstyle}{joinstyle}{Specifies the form of the joint between the curve
segments. This attribute is only applicable if the curve outline relief is flat.
The default value is {\tt round}.}
\attribute{lastend}{lineend}{Describe the arrow shape at the end of the curve.
This attribute is applicable only if the item is not closed, not filled and
the relief of the outline is flat. The default value is {\tt ""}.}
\attribute{linecolor}{color}{Specifies the color that will be used to draw
the item outline. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
scalable). The default value is {\tt 1}.}
\attribute{marker}{bitmap}{Specifies a bitmap that will be used to draw a mark at
each vertex of the curve. This attribute is not applicable if the outline relief is
not flat. The default value is {\tt ""} which means do not draw markers.}
\attribute{markercolor}{color}{Specifies the color of the markers.
The default value is the current value of the widget option \ident{-foreground}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the curve
outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
tiles. This will be done only if filling is requested by the \ident{filled} attribute.
This attribute has priority over the \ident{gradient} attribute when no gradient is
specified (paint solid) and the \ident{fillpattern} attribute. The default value is
{\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Bezier items}
\object{bezier}
Items of type \ident{bezier} display a path of Bezier cubic segments connected
by their end points. Each segment is described by four control points, two
located at the ends of the segment and two located off curve. The last segment
can contain less than four points but at least two. If it contains two points
a straight line segment is drawn, if it contains three points, the second
point is used as the two off-curve control points. The polygon delimited by the
path can optionally be filled.
It is possible to use this item as a clip item for its group, the clip
shape will be the polygon obtained by closing the path. It is also possible
to use this polygon in a \ident{contour} command to build a complex shape
in a \ident{curve} item. The controls points can be read, modified, added or
removed with the \ident{coords} command.
Applicable attributes for \ident{bezier}:
\attribute{capstyle}{capstyle}{Specifies the form of the outline ends. This
attribute is only applicable if the bezier is not closed and the outline relief is
flat. The default value is {\tt round}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
the bezier if requested by the \ident{filled} attribute. The default value is a
one color gradient based on the current value of the widget option
\ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start of the bezier.
This attribute is applicable only if the item is not filled and the relief of the
outline is flat. The default value is {\tt ""}.}
\attribute{gradient}{gradientgeometry}{Specifies the type and geometry of the
gradient that should be drawn to fill the item. This will be done only if filling is
requested by the \ident{filled} attribute. The default value is {\tt ""} which means
no gradient geometry, fill with solid color. When a value other than the default is
specified, this attribute has priority over the \ident{tile} and \ident{fillpattern}
attributes.}
\attribute{lastend}{lineend}{Describe the arrow shape at the end of the bezier.
This attribute is applicable only if the item is not filled and the relief of the
outline is flat. The default value is {\tt ""}.}
\attribute{linecolor}{color}{Specifies the color that will be used to draw
the item outline. The default value is the current value of the widget option
\ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
scalable). The default value is {\tt 1}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the bezier
outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
tiles. This will be done only if filling is requested by the \ident{filled} attribute.
This attribute has priority over the \ident{gradient} attribute when no gradient is
specified (paint solid) and the \ident{fillpattern} attribute. The default value is
{\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\section{Window items}
\object{window}
Items of type \ident{window} display an X11 window at a given position in the
widget.
It is possible to use this item as a clip item for its group, the clip
shape will be the window rectangle. It is also possible to use the rectangular
shape of the window item in a \ident{contour} command to build a complex shape
in a \ident{curve} item. The position of the window, relative to the anchor,
can be set or read with the \ident{coords} command (i.e. if no connected item
is specified).
One of the most frequent use of this item is to embed any Tk widget
into zinc, including, of course, another zinc instance. Another less obvious
use is to embed a whole Tk application into zinc, here is how to do it:
The embedding application should create a frame with the \ident{-container}
option set to true; Add a window item to the relevant zinc widget with the
\ident{window} attribute set to the id of the container frame; The embedded
application should create its toplevel with the \ident{-use} option set to
the id of the container frame; Or, as an alternative, the embedded \cident{wish}
can be launched with the \ident{-use} option set to the container frame id.
Applicable attributes for \ident{window}:
\attribute{anchor}{anchor}{The anchor used in positionning the item.
The default value is {\tt nw}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
be composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this
item is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected
item used for the placement. The default value is {\tt sw}.}
\attribute{height}{dimension}{Specifies the height of the item window in
screen units. The default value is {\tt 0}.}
\attribute{position}{position}{The item's position relative to the anchor
(if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{Constraints of the underlying window sytem
dictate the stacking order of window items. They can't be lowered under the
other items. Additionally, to manipulate their stacking order, you must use
the raise and lower Tk commands on the associated Tk window. The value of this
attribute is meaningless.}
\attribute{sensitive}{boolean}{This option has no effect on window items.
The default value is {\tt False}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
value is {\tt true}.}
\attribute{width}{dimension}{Specifies the width of the item window in
screen units. The default value is {\tt 0}.}
\attribute{window}{window}{Specifies the X id of the window that is displayed
by the item. This id can be obtained by the Tk command \ident{winfo id widgetname}.
The default value is {\tt ""}.}
\chapter{The \ident{mapinfo} command}
\label{mapinfocmd}
MapInfo objects are used to describe graphical primitives that will be
displayed in map items. It is possible to describe lines, arcs, symbols
and texts as part of a MapInfo. The \ident{mapinfo} and \ident{videomap}
commands are provided to create and manipulate the mapinfo objects.
\mapinfocmd{name}{create}{}
\begin{blockindent}
Create a new empty map description. The new mapinfo object named {\tt name}.
\end{blockindent}
\mapinfocmd{mapInfoName}{delete}{}
\begin{blockindent}
Delete the mapinfo object named by {\tt mapInfoName}. All maps that refer to
the deleted mapinfo are updated to reflect the change.
\end{blockindent}
\mapinfocmd{mapInfoName}{duplicate}{newName}
\begin{blockindent}
Create a new mapinfo that is a exact copy of the mapinfo named {\tt mapInfoName}.
The new mapinfo object will be named {\tt newName}.
\end{blockindent}
\mapinfocmd{name}{add}{type args}
\begin{blockindent}
Add a new graphical element to the mapinfo object named by {\tt name}. The
{\tt type} parameter select which element should be added while the {\tt args}
arguments provide some type specific values such as coordinates. Here is
a description of recognized types and their associated parameters.
\begin{description}
\item{line} \\
This element describes a line segment. Its parameters consists in a line
style ({\tt simple}, {\tt dashed}, {\tt dotted}, {\tt mixed}, {\tt marked}),
an integer value setting the line width in pixels and four integer values
setting the X and Y coordinates of the two end vertices.
\item{arc} \\
This element describes an arc segment. Its parameters consists in a line
style ({\tt simple}, {\tt dashed}, {\tt dotted}, {\tt mixed}, {\tt marked}),
an integer value setting the line width in pixels, two integer values
setting the X and Y of the arc center, integer value setting the arc radius
and two integer values setting the start angle and the angular extent of the
arc.
\item{symbol} \\
This element describes a symbol. Its parameters consists in two integer values
setting the X and Y of the symbol position and an integer setting the symbol
index in the {\tt -symbols} list of the map item.
\item{text} \\
This element describes a line of text. Its parameters consists in a text style
({\tt normal}, {\tt underlined}), a line style ({\tt simple}, {\tt dashed},
{\tt dotted}, {\tt mixed}, {\tt marked}) to be used for the underline, two
integer values setting the X and Y of the text position and a string describing
the text.
\end {description}
\end{blockindent}
\mapinfocmd{name}{count}{type}
\begin{blockindent}
Return an integer value that is the number of elements matching {\tt type} in
the mapinfo named {\tt name}. {\tt type} may be one the legal element types as
described in the {\tt mapinfo add} command.
\end{blockindent}
\mapinfocmd{name}{get}{type index}
\begin{blockindent}
Return the parameters of the element at {\tt index} with type {\tt type}
in the mapinfo named {\tt name}. The returned value is a list. The exact
number of parameters in the list and their meaning depend on {\tt type}
and is accurately described in \ident{mapinfo add}. {\tt type} may be one
the legal element types as described in the {\tt mapinfo add} command.
Indices are zero based and elements are listed by type.
\end{blockindent}
\mapinfocmd{name}{replace}{type index args}
\begin{blockindent}
Replace all parameters for the element at {\tt index} with type {\tt type}
in the mapinfo named {\tt name}. The exact number and content for {\tt args}
depend on {\tt type} and is accurately described in \ident{mapinfo add}.
{\tt type} may be one the legal element types as described in the
{\tt mapinfo add} command. Indices are zero based and elements are listed
by type.
\end{blockindent}
\mapinfocmd{name}{remove}{type index}
\begin{blockindent}
Remove the element at {\tt index} with type {\tt type} in the mapinfo
named {\tt name}. {\tt type} may be one the legal element types as
described in the {\tt mapinfo add} command. Indices are zero based and
elements are listed by type.
\end{blockindent}
\mapinfocmd{name}{scale}{factor}
\begin{blockindent}
Scale all coordinates of all the elements described in the mapinfo named
{\tt name} by {\tt factor}. The same value is used for X and Y axes.
\end{blockindent}
\mapinfocmd{name}{translate}{xAmount yAmount}
\begin{blockindent}
Translate all coordinates of all the elements described in the mapinfo named
{\tt name}. The {\tt xAmount} value is used for the X axis and the
{\tt yAmount} value is used for the Y axis.
\end{blockindent}
\chapter{The \ident{videomap} command}
\command{videomap}{ids}{fileName}
\begin{blockindent}
Return all sub-map ids that are described in the videomap file described
by {\tt fileName}. The ids are listed in file order. This command makes
possible to iterate through a videomap file one sub-map at a time, to know
how much sub-maps are there and to sort them according to their ids.
\end{blockindent}
\command{videomap}{load}{fileName index mapInfoName}
\begin{blockindent}
Load the videomap sub-map located at position {\tt index} in the file named
{\tt fileName} into a mapinfo object named {\tt mapInfoName}. It is possible,
if needed, to use the \ident{videomap ids} command to help translate a sub-map
id into a sub-map file index.
\end{blockindent}
\chapter{Other resources provided by the widget}
\section{Bitmaps}
\label{builtinbitmaps}
Zinc creates two sets of bitmaps.
The first set contains symbols for ATC tracks, maps and
waypoints, these bitmaps are named AtcSymbol1 to AtcSymbol22.
\latexhtml{%
\includegraphics{atcsymb.ps}}{%
\htmladdimg{atcsymb.png}
}
The second set provides stipples that can be used to implement
transparency, they are named AlphaStipple0 to AlphaStipple15,
AlphaStipple0 being the most transparent.
\latexhtml{%
\includegraphics{alphastip.ps}}{%
\htmladdimg{alphastip.png}
}
\latex {\tolerance 2000 %allow somewhat looser lines.
\hbadness 10000 } %don't complain about underfull lines.
\tableofcontents
\listoftables
\listoffigures
\printindex
\label{interne:DernierePage}
\end{document}
|