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 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644
|
########################################################################
##
## Copyright (C) 2014-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{retval} =} genpropdoc (@var{OBJNAME}, @var{FILENAME})
##
## Print FILENAME texinfo source file associated to OBJNAME objects. This
## function is meant to be run for generating octave documentation
## (see doc/interpreter/graphics_properties.mk).
##
## All the hard coded documentation is written in getdoc function. See the
## comments in getdoc bellow for instruction on how to document a graphics
## property.
##
## @seealso{}
## @end deftypefn
function genpropdoc (objname, fname = "", props = {})
objnames = {"root", "figure", "axes", "legend", ...
"image", "light", "line", "patch", "scatter", "surface", ...
"text", "uibuttongroup", "uicontextmenu", "uicontrol", ...
"uipanel", "uimenu", "uipushtool", "uitable", ...
"uitoggletool", "uitoolbar"
};
## Base properties
base = getstructure ("base");
## Object properties
if (any (strcmp (objname, objnames)))
obj = getstructure (objname, base, props);
else
error ("genpropdoc: unknown object %s", objname);
endif
## Docstring
str = printdoc (objname, obj, ! isempty (props));
if (! isempty (fname))
fid = fopen (fname, "w+");
if (fid < 0)
error ("genpropdoc: couldn't open %s.", fname);
endif
else
fid = stdout;
endif
fprintf (fid, str);
if (nargin == 2)
fclose (fid);
endif
endfunction
function s = getdoc (objname, field, base)
## Properties are represented by a struct with fields :
##
## -"doc": string to be printed verbatim after being expanded
## through expand_doc function. Special keywords are:
## "__objname__" : replaced by the current object name;
## "__prop__" : replaced by the current property name;
## "__modemsg__" : replaced by a message explaining that
## the propmode will be toggled to "manual".
## "__fcnmsg__" : replaced by a message explaining where to find
## documentation on the form of a callback function.
## You may also cross reference properties using the label format
## OBJNAMEPROPERTY, e.g., "@xref{XREFaxescolor, , axes color property}."
##
## -"valid": string that describes valid values for the current property.
## Use "packopt" function to join options with " | " separator
## and "markdef" to mark default among valid values between curly braces.
## If not provided, valid values for radio properties are automatically
## retrieved using set function.
##
## -"default": string. If not provided the default value is automatically
## retrieved using get function.
##
## -"printdefault": a boolean (def. true) that specifies whether the
## default value should be printed. It is useful for properties
## like root "screendepth" that default to screen dependent values.
##
## -"category": a string that is used to group properties. Properties
## without category designations will be defaulted into a "Miscellaneous"
## category. The "Miscellaneous" and (if it is used) the "Unused"
## categories will be sorted to the end of each document.
packopt = @(c) strjoin (c, " | ");
markdef = @(s) ["@{" s "@}"];
## Some generic templates:
valid_color = "colorspec";
valid_handle = "graphics handle";
valid_string = "string";
valid_fcn = packopt ({"string", "function handle"});
valid_cellstring = packopt ({"string", "cell array of strings"});
valid_2elvec = "two-element vector";
valid_3elvec = "three-element vector";
valid_4elvec = "four-element vector";
valid_vecmat = packopt ({"vector", "matrix"});
valid_scalmat = packopt ({"scalar", "matrix"});
valid_scalmatarr = packopt ({"scalar", "matrix", "array"});
doc_notimpl = "%s is not yet implemented for __objname__ objects. \
__prop__ is unused.";
doc_unused = "__prop__ is unused.";
doc_fontangle = "Control whether the font is italic or normal.";
doc_fontsize = "Size of the font used for text rendering. \
@xref{XREF__objname__fontunits, , fontunits property}.";
doc_fontname = "Name of font used for text rendering. When setting \
this property, the text rendering engine will search for a matching \
font in your system. If none is found then text is rendered using a \
default sans serif font (same as the default @qcode{\"*\"} value).\n\n\
Programming Note: On systems that don’t use FontConfig natively \
(all but Linux), the font cache is built when Octave is installed. \
You will need to run @code{system (\"fc-cache -fv\")} manually after \
installing new fonts.";
doc_fontunits = "Units used to interpret the @qcode{\"fontsize\"} property.";
doc_fontweight = "Control the variant of the base font used for \
text rendering.";
## Initialize structure
if (isfield (base, field))
s = base.(field);
else
s = struct ("valid", "", "default", "", "doc", "", ...
"printdefault", true, "category", "Miscellaneous");
endif
## Base properties: Write generic documentation because it will be included
## in the list of each graphics object. If a given graphics object
## interprets the property differently than others, then the doc will have
## to be rewritten for this object.
if (strcmp (objname, "base"))
switch (field)
case "beingdeleted"
s.doc = "Property indicating that a function has initiated deletion \
of the object. __prop__ is set to true until the object no longer exists.";
s.category = "Creation/Deletion";
case "busyaction"
s.doc = "Define how Octave handles the execution of this object's \
callback properties when it is unable to interrupt another object's \
executing callback. This is only relevant when the currently executing \
callback object has its @code{interruptible} property set to \
\@qcode{\"off\"}. The __prop__ property of the interrupting callback object \
indicates whether the interrupting callback is queued (@qcode{\"queue\"} \
(default)) or discarded (@qcode{\"cancel\"}).\n\
@xref{Callbacks, , @w{Callbacks section}}.";
s.category = "Callback Execution";
case "buttondownfcn"
s.doc = "__fcnmsg__";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "children"
s.doc = "Graphics handles of the __objname__'s children.";
s.valid = "vector of graphics handles";
s.category = "Parent/Children";
case "clipping"
s.doc = "If __prop__ is @qcode{\"on\"}, the __objname__ is \
clipped in its parent axes limits.";
s.category = "Display";
case "contextmenu"
s.doc = "Graphics handle of the uicontextmenu object that is \
currently associated to this __objname__ object.";
s.valid = valid_handle;
s.category = "Mouse Interaction";
case "createfcn"
s.doc = "Callback function executed immediately after __objname__ \
has been created. Function is set by using default property on root object, \
e.g., @code{set (groot, \"default__objname__createfcn\", \
'disp (\"__objname__ created!\")')}.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Creation/Deletion";
case "deletefcn"
s.doc = "Callback function executed immediately before __objname__ \
is deleted.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Creation/Deletion";
case "handlevisibility"
s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__'s \
handle is not visible in its parent's @qcode{\"children\"} property.";
s.category = "Parent/Children";
case "hittest"
s.doc = "Specify whether __objname__ processes mouse events \
or passes them to ancestors of the object. When enabled, the object may \
respond to mouse clicks by evaluating the @qcode{\"buttondownfcn\"}, showing \
the uicontextmenu, and eventually becoming the root \
@qcode{\"currentobject\"}. This property is only relevant when the object \
can accept mouse clicks which is determined by the @qcode{\"pickableparts\"} \
property. @xref{XREF__objname__pickableparts, , @w{pickableparts property}}.";
s.category = "Mouse Interaction";
case "interruptible"
s.doc = "Specify whether this object's callback functions may be \
interrupted by other callbacks. By default __prop__ is @qcode{\"on\"} \
and callbacks that make use of @code{drawnow}, @code{figure}, @code{waitfor}, \
@code{getframe} or @code{pause} functions are eventually interrupted.\n\
@xref{Callbacks, , @w{Callbacks section}}.";
s.category = "Callback Execution";
case "parent"
s.doc = "Handle of the parent graphics object.";
s.valid = valid_handle;
s.category = "Parent/Children";
case "pickableparts"
s.doc = "Specify whether __objname__ will accept mouse clicks. \
By default, __prop__ is @qcode{\"visible\"} and only visible parts of the \
__objname__ or its children may react to mouse clicks. When __prop__ is \
@qcode{\"all\"} both visible and invisible parts (or children) may react to \
mouse clicks. When __prop__ is @qcode{\"none\"} mouse clicks on the object \
are ignored and transmitted to any objects underneath this one. When an \
object is configured to accept mouse clicks the @qcode{\"hittest\"} property \
will determine how they are processed. \
@xref{XREF__objname__hittest, , @w{hittest property}}.";
s.category = "Mouse Interaction";
case "selected"
s.doc = "Property indicates whether this __objname__ is selected.";
s.category = "Mouse Interaction";
case "selectionhighlight"
s.doc = "If __prop__ is @qcode{\"on\"}, then the __objname__'s \
selection state is visually highlighted.";
s.category = "Mouse Interaction";
case "tag"
s.doc = "A user-defined string to label the graphics object.";
s.valid = valid_string;
s.category = "Object Identification";
case "type"
s.doc = "Class name of the graphics object. __prop__ is \
always @qcode{\"__objname__\"}.";
s.valid = valid_string;
s.printdefault = false;
s.category = "Object Identification";
case "userdata"
s.doc = "User-defined data to associate with the graphics object.";
s.valid = "Any Octave data";
s.category = "Object Identification";
case "visible"
s.doc = "If __prop__ is @qcode{\"off\"}, the __objname__ is \
not rendered on screen.";
s.category = "Display";
endswitch
## Root properties:
elseif (strcmp (objname, "root"))
switch (field)
## Overridden shared properties
case {"beingdeleted", "busyaction", "buttondownfcn", ...
"clipping", "createfcn", "deletefcn", ...
"hittest", "interruptible", "pickableparts", "selected", ...
"selectionhighlight", "uicontextmenu", "visible"}
s.doc = doc_unused;
s.category = "Unused";
case "handlevisibility"
s.doc = "The root object handle is always visible. Changing this \
setting to @qcode{\"callback\"} or @qcode{\"off\"} has no effect.";
## Use base category.
case "parent"
s.doc = "Root object has no parent graphics object. __prop__ \
is always empty.";
## Use base category.
## Specific properties
case "callbackobject"
s.doc = "Graphics handle of the current object whose callback is \
executing.";
s.valid = valid_handle;
s.category = "Callback Execution";
case "commandwindowsize"
s.doc = "The number of columns and rows displayed in a newly created \
command window.";
s.valid = valid_2elvec;
s.category = "Command Window Display";
case "currentfigure"
s.doc = "Graphics handle of the current figure.";
s.valid = valid_handle;
s.category = "Object Identification";
case "diary"
s.doc = "If __prop__ is @qcode{\"on\"}, the Octave command window \
session is saved to file. @xref{XREFrootdiaryfile, , @w{diaryfile property}}.";
s.category = "Command Logging";
case "diaryfile"
s.doc = "The name of the diary file. \
@xref{XREFdiary, , @w{diary function}}.";
s.valid = valid_string;
s.category = "Command Logging";
case "echo"
s.doc = "Control whether Octave displays commands executed from \
scripts. @xref{XREFecho, , @w{echo function}}.";
s.category = "Command Window Display";
case "fixedwidthfontname"
s.doc = "Name of the fixed-width font that will be used for \
graphics objects when the @qcode{\"fontname\"} property is set to \
@qcode{\"FixedWidth\"}.";
s.valid = valid_string;
s.category = "Command Window Display";
case "format"
s.doc = "This property is a wrapper around the @code{format} function.\
@xref{XREFformat, , @w{format function}}.";
s.category = "Command Window Display";
case "formatspacing"
s.doc = "This property is a wrapper around the @code{format} function.\
@xref{XREFformat, , @w{format function}}.";
s.category = "Command Window Display";
case "monitorpositions"
s.doc = "Reports the width and height of connected monitors. Note: \
Octave only partially implements __prop__. Only information about the primary \
monitor is stored in __prop__ which is the same information stored in the \
@ref{XREFrootscreensize, , @w{@qcode{\"screensize\"} property}}.";
s.printdefault = false;
s.valid = valid_4elvec;
s.category = "Screen Information";
case "pointerlocation"
s.doc = [sprintf(doc_notimpl, "Global pointer location \
tracking"), " __prop__ for __objname__ objects will always be \
[0 0]."];
s.valid = valid_2elvec;
s.category = "Pointer Information";
case "pointerwindow"
s.doc = [sprintf(doc_notimpl, "Pointer window tracking"), ...
" __prop__ value for __objname__ objects will always be 0."];
s.valid = valid_handle;
s.category = "Pointer Information";
case "screendepth"
s.doc = "Color depth in bits per pixel of the display.";
s.valid = "double";
s.printdefault = false;
s.category = "Screen Information";
case "screenpixelsperinch"
s.doc = "The screen resolution of the primary display in units of \
pixels per inch.";
s.valid = "double";
s.printdefault = false;
s.category = "Screen Information";
case "screensize"
s.doc = "Size of the primary display represented as the four-element \
vector [left, bottom, width, height].";
s.valid = valid_4elvec;
s.printdefault = false;
s.category = "Screen Information";
case "showhiddenhandles"
s.doc = "If __prop__ is @qcode{\"on\"}, all graphics objects handles \
are visible in their parents' children list, regardless of the value of their \
@code{handlevisibility} property.";
s.category = "Parent/Children";
case "units"
s.doc = "The unit type used for the \
@ref{XREFrootmonitorpositions, , @qcode{\"monitorpositions\"}}, \
@ref{XREFrootpointerlocation, , @qcode{\"pointerlocation\"}}, and \
@ref{XREFrootscreensize, , @qcode{\"screensize\"}} properties.";
s.category = "Screen Information";
endswitch
## Figure properties
elseif (strcmp (objname, "figure"))
switch (field)
## Overridden shared properties
case {"clipping", "pickableparts"}
s.doc = doc_unused;
s.category = "Unused";
## Specific properties
case "alphamap"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Appearance";
case "closerequestfcn"
s.doc = "Function that is executed when a figure is deleted. \
@xref{XREFclosereq, , closereq function}.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Creation/Deletion";
case "color"
s.doc = "Color of the figure background. \
@xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Appearance";
case "colormap"
s.doc = "A matrix containing the RGB color map for the current axes.";
s.valid = "N-by-3 matrix";
s.category = "Appearance";
case "currentaxes"
s.doc = "Handle to the graphics object of the current axes.";
s.valid = valid_handle;
s.category = "Object Identification";
case "currentcharacter"
s.doc = sprintf (doc_notimpl, "Tracking of the last key pressed");
s.category = "Object Identification";
case "currentobject"
s.doc = "Handle to the most recently active graphics object in the \
figure.";
s.valid = valid_handle;
s.category = "Object Identification";
case "currentpoint"
s.doc = "A 1-by-2 vector which holds the coordinates of the point \
over which the mouse pointer was when a mouse event occurred. The X and Y \
coordinates are in units defined by the figure's @code{units} property \
and their origin is the lower left corner of the plotting area.\n\
\n\
Events which set @code{currentpoint} are\n\
@table @asis\n\
@item A mouse button was pressed\n\
always\n\
@item A mouse button was released\n\
only if the figure's callback @code{windowbuttonupfcn} is defined\n\
@item The pointer was moved while pressing the mouse button (drag)\n\
only if the figure's callback @code{windowbuttonmotionfcn} is defined\n\
@end table";
s.valid = valid_2elvec;
s.category = "Mouse Interaction";
case "dockcontrols"
s.doc = sprintf (doc_notimpl, "Interactive figure docking");
s.category = "Object Position";
case "filename"
s.doc = "The filename used when saving the plot figure.";
s.valid = valid_string;
s.category = "Printing/Saving";
case "graphicssmoothing"
s.doc = "Use smoothing techniques to reduce the appearance of jagged \
lines.";
s.category = "Appearance";
case "innerposition"
s.doc = "The @qcode{\"innerposition\"} property is the same as the \
@ref{XREFfigureposition, , @w{@qcode{\"position\"} property}}.";
s.valid = valid_4elvec;
s.category = "Object Position";
case "integerhandle"
s.doc = "Assign the next lowest unused integer as the Figure number.";
s.category = "Object Identification";
case "inverthardcopy"
s.doc = "Replace the figure and axes background color with white when \
printing.";
s.category = "Printing/Saving";
case "keypressfcn"
s.doc = "Callback function executed when a keystroke event \
happens while the figure has focus. The actual key that was pressed \
can be retrieved using the second argument 'evt' of the function.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Keyboard Interaction";
case "keyreleasefcn"
s.doc = "With @code{keypressfcn}, the keyboard callback functions. \
These callback functions are called when a key is pressed/released \
respectively. The functions are called with two input arguments. The first \
argument holds the handle of the calling figure. The second argument holds \
an event structure which has the following members:\n\
@table @code\n\
@item Character:\n\
The ASCII value of the key\n\
@item Key:\n\
Lowercase value of the key\n\
@item Modifier:\n\
A cell array containing strings representing the modifiers pressed with the \
key.\n\
@end table\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Keyboard Interaction";
case "menubar"
s.doc = "Control the display of the figure menu bar at the top \
of the figure.";
s.category = "Mouse Interaction";
case "name"
s.doc = "Name to be displayed in the figure title bar. The name is \
displayed to the right of any title determined by the @code{numbertitle} \
property.";
s.valid = valid_string;
s.category = "Appearance";
case "nextplot"
s.doc = "__prop__ is used by high level plotting functions to \
decide what to do with axes already present in the figure. \
@xref{XREFnewplot, , @w{newplot function}}.";
s.category = "Object Identification";
case "number"
s.doc = "Number of the current __objname__.";
s.valid = "double";
s.category = "Object Identification";
case "numbertitle"
s.doc = "Display @qcode{\"Figure\"} followed by the numerical figure \
handle value in the figure title bar.";
s.category = "Appearance";
case "outerposition"
s.doc = "Specify the position and size of the figure including \
the top menubar and the bottom status bar. \
The four elements of the vector are the coordinates of the lower left corner \
and width and height of the figure. \
@xref{XREFfigureunits, , @w{units property}}.";
s.valid = valid_4elvec;
s.category = "Object Position";
case "paperorientation"
s.doc = "The value for the @code{papersize}, and @code{paperposition} \
properties depends upon __prop__. The horizontal and vertical values for \
@code{papersize} and @code{paperposition} reverse order \
when __prop__ is switched between @code{\"portrait\"} and \
@code{\"landscape\"}.";
s.category = "Printing/Saving";
case "paperposition"
s.doc = "Vector @code{[left bottom width height]} defining the \
position and size of the figure (in @code{paperunits} units) on the printed \
page. The position @code{[left bottom]} defines the lower left corner of the \
figure on the page, and the size is defined by @code{[width height]}. For \
output formats not implicitly rendered on paper, @code{width} and \
@code{height} define the size of the image and the position information is \
ignored. __modemsg__";
s.valid = valid_4elvec;
s.category = "Printing/Saving";
case "paperpositionmode"
s.doc = "If __prop__ is set to @qcode{\"auto\"}, the \
@code{paperposition} property is automatically computed: the printed \
figure will have the same size as the on-screen figure and will be centered \
on the output page. Setting the __prop__ to @code{\"auto\"} does not modify \
the value of the @code{paperposition} property.";
s.category = "Printing/Saving";
case "papersize"
s.doc = "Vector @code{[width height]} defining the size of the \
paper for printing. Setting the __prop__ property to a value, not associated \
with one of the defined @code{papertypes} and consistent with the setting for \
@code{paperorientation}, forces the @code{papertype} property to the value \
@qcode{\"<custom>\"}. If __prop__ is set to a value associated with a \
supported @code{papertype} and consistent with the @code{paperorientation}, \
the @code{papertype} value is modified to the associated value.";
s.valid = valid_2elvec;
s.category = "Printing/Saving";
case "papertype"
s.doc = "Name of the paper used for printed output. \
Setting __prop__ also changes @code{papersize}, while maintaining consistency \
with the @code{paperorientation} property.";
s.category = "Printing/Saving";
case "paperunits"
s.doc = "The unit used to compute the @code{paperposition} property. \
The conversion from physical units (e.g., @code{\"inches\"}) is dependent on \
the @code{screenpixelsperinch} property of the root object.";
s.category = "Printing/Saving";
case "pointer"
s.doc = "Name of the mouse pointer shape associated with the canvas \
of the figure. When __prop__ is @qcode{\"custom\"}, the shape is determined \
by the @code{pointershapecdata} property.\n\n\
__prop__ has no effect when the figure is in zoom, pan, or rotate mode. \
In this case, Octave automatically uses a pointer shape appropriate \
to the mode.";
s.category = "Mouse Interaction";
case "pointershapecdata"
s.doc = "m-by-m matrix defining a custom pointer. Each \
element defines a pixel with the element (1,1) representing the \
top-left pixel. A value of 1 is colored black, a value of 2 is colored white, \
and all other values are rendered as transparent.";
s.valid = "16-by-16 or 32-by-32 Matrix";
s.category = "Mouse Interaction";
case "pointershapehotspot"
s.doc = "For custom pointers only __prop__ defines the row and \
column of the pixel in @code{pointershapecdata} that is used as the pointer \
location.";
s.valid = valid_2elvec;
s.category = "Mouse Interaction";
case "position"
s.doc = "Specify the position and size of the figure canvas. \
The four elements of the vector are the coordinates of the lower left corner \
and width and height of the figure. \
@xref{XREFfigureunits, , @w{units property}}.";
s.valid = valid_4elvec;
s.category = "Object Position";
case "renderer"
s.doc = "Rendering engine used for printing when @code{renderermode} \
is @qcode{\"manual\"}. __modemsg__";
s.category = "Printing/Saving";
case "renderermode"
s.doc = "Control whether the rendering engine used for printing is \
chosen automatically or specified by the @code{renderer} property. \
@xref{XREFprint, , @w{print function}}.";
s.category = "Printing/Saving";
case "resize"
s.doc = "Control whether the figure can be resized by dragging the \
window borders and corners using a mouse. When __prop__ is @qcode{\"off\"} \
mouse interactions are disabled but the figure can still be resized by \
changing its @qcode{\"position\"} property.";
s.category = "Mouse Interaction";
case "resizefcn"
s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "selectiontype"
s.doc = "Selection type of the latest mouse click.\n\n\
__prop__ may take different values depending on the combination of mouse \
button and keyboard modifier that were used:\n\
@table @code\n\
@item normal:\n\
Left-click.\n\
@item alt:\n\
Right-click or Ctrl+Left-click.\n\
@item extend:\n\
Shift+Left-click, Middle click, or combined Left-click and Right-click.\n\
@item open:\n\
Double Left-click.\n\
@end table";
s.category = "Mouse Interaction";
case "sizechangedfcn"
s.doc = "Callback triggered when the figure window size is changed.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "toolbar"
s.doc = "Control the display of the toolbar (along the bottom of the \
menubar) and the status bar. When set to @qcode{\"auto\"}, the display is \
based on the value of the @ref{XREFfiguremenubar,,@qcode{\"menubar\"}} \
property.";
s.category = "Mouse Interaction";
case "units"
s.doc = "The unit used to compute the \
@ref{XREFfigureposition,,position} and \
@ref{XREFfigureouterposition,,outerposition} properties.";
s.category = "Object Position";
case "windowbuttondownfcn"
s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
@w{windowbuttonupfcn property}}.";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "windowbuttonmotionfcn"
s.doc = "@xref{XREFfigurewindowbuttonupfcn, , \
@w{windowbuttonupfcn property}}.";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "windowbuttonupfcn"
s.doc = "With @code{windowbuttondownfcn} and \
@code{windowbuttonmotionfcn}, the mouse callback functions. These \
callback functions are called when a mouse button is pressed, dragged, or \
released respectively. When these callback functions are executed, the \
@code{currentpoint} property holds the current coordinates of the cursor.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "windowkeypressfcn"
s.doc = "Function that is executed when a key is pressed and \
the figure has focus.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Keyboard Interaction";
case "windowkeyreleasefcn"
s.doc = "Function that is executed when a key is released and \
the figure has focus.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Keyboard Interaction";
case "windowscrollwheelfcn"
s.doc = "Function that is executed when a user manipulates \
the mouse wheel over this figure. \
The function is called with two input arguments. The first \
argument holds the handle of the calling figure. The second argument holds \
an event structure which has the following members:\n\
@table @code\n\
@item VerticalScrollCount:\n\
The number of wheel steps, typically 1 when scrolling down and -1 when \
scrolling up.\n\
@item VerticalScrollAmount:\n\
The number of lines a wheel step should scroll. This value is always 3.\n\
@item EventName:\n\
The event name which is @qcode{\"WindowScrollWheel\"}.\n\
@end table\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Mouse Interaction";
case "windowstate"
s.doc = sprintf (doc_notimpl, "Window state adjustment");
s.category = "Display";
case "windowstyle"
s.doc = "The window style of a figure. One of the following values:\n\
@table @code\n\
@item normal\n\
The window may be unselected and other windows may be shown in front of the \
window.\n\
@item modal\n\
The window will stay on top of all normal figures until it is dismissed.\n\
@item docked\n\
Unimplemented.\n\
@end table\n\
\n\
Changing modes of a visible figure may cause the figure to close and reopen.";
s.category = "Display";
endswitch
## Axes properties
elseif (strcmp (objname, "axes") || strcmp (objname, "legend"))
switch (field)
## Overridden shared properties
case "clipping"
s.doc = sprintf (doc_notimpl, "Axes-children clipping control");
## Use base category.
## Specific properties
case "alim"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "alimmode"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "alphamap"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "alphascale"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "ambientlightcolor"
s.doc = sprintf (doc_notimpl, "Uniform background axes lighting");
s.category = "Color and Transparency";
case "box"
s.doc = "Control whether the __objname__ has a surrounding box.";
if (strcmp (objname, "legend"))
s.category = "Legend Appearance";
else
s.category = "Axes Box Appearance";
endif
case "boxstyle"
s.doc = "For 3-D axes, control whether the @qcode{\"full\"} \
box is drawn or only the 3 @qcode{\"back\"} axes.";
s.category = "Axes Box Appearance";
case "cameraposition"
s.doc = "Coordinates of the camera position viewing the \
__objname__. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";
case "camerapositionmode"
s.doc = "Current state of the camera position property, whether \
automatically set according to the @ref{XREFview, , view function}, or \
manually set with the \
@ref{XREFaxescameraposition, , @w{@qcode{\"cameraposition\"} property}}.";
s.category = "Camera and View Controls";
case "cameratarget"
s.doc = "Coordinates of the point at which the viewing camera is \
aimed. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";
case "cameratargetmode"
s.doc = "Current state of camera target property, either manually \
set with the \
@ref{XREFaxescameratarget, , @w{@qcode{\"cameratarget\"} property}} or \
automatically positioned at the center of the axes plot area.";
s.category = "Camera and View Controls";
case "cameraupvector"
s.doc = "A 3-element vector defining the upward direction of the \
current view. Note that the default is [0 1 0] for 2-D plots and [0 0 1] for \
3-D plots. __modemsg__";
s.valid = valid_3elvec;
s.category = "Camera and View Controls";
case "cameraupvectormode"
s.doc = "Current state of camera up vector property, set to manual \
when the \
@ref{XREFaxescameraupvector, , @w{@qcode{\"cameraupvector\"} property}} is \
used to change the vector from the 2-D or 3-D default values.";
s.category = "Camera and View Controls";
case "cameraviewangle"
s.doc = "The camera's field of view defined as an angle between 0 \
and 180 degrees. __modemsg__";
s.valid = "scalar";
s.category = "Camera and View Controls";
case "cameraviewanglemode"
s.doc = "Current state of the camera view angle property, either \
manually set with the \
@ref{XREFaxescameraviewangle, , @w{@qcode{\"cameraviewangle\"} property}} \
or automatically set by Octave to include all visible objects.";
s.category = "Camera and View Controls";
case "clim"
s.doc = "Define limits for the color axis of __objname__ \
children that have the @code{cdata} property. \
__modemsg__";
s.valid = valid_2elvec;
s.category = "Color and Transparency";
case "climmode"
s.doc = "Current state of the color limit mode, either \
manually set by the \
@ref{XREFaxesclim, , @w{@qcode{\"clim\"} property}} or automatically set by \
Octave to the minimum and maximum @code{cdata} values of __objname__'s \
children.";
s.category = "Color and Transparency";
case "clippingstyle"
s.doc = sprintf (doc_notimpl, "Axes-children clipping control");
s.category = "Display";
case "color"
s.doc = "Color of the __objname__ background. \
@xref{Colors, , colorspec}.";
s.valid = valid_color;
if (strcmp (objname, "legend"))
s.category = "Legend Appearance";
else
s.category = "Axes Box Appearance";
endif
case "colormap"
s.doc = "A matrix containing the RGB color map for this __objname__ \
object.";
s.valid = "N-by-3 matrix";
s.category = "Color and Transparency";
case "colororder"
s.doc = "RGB values used by plot function for child object coloring.";
s.valid = "N-by-3 RGB matrix";
s.category = "Automatic Child Properties";
case "colororderindex"
s.doc = "Index of the next color from the \
@ref{XREFaxescolororder, , @w{@qcode{\"colororder\"} property}} to be used \
by Axes-child objects.";
s.valid = "integer";
s.category = "Automatic Child Properties";
case "colorscale"
s.doc = sprintf (doc_notimpl, "Automatic linear/log color scaling");
s.category = "Color and Transparency";
case "currentpoint"
s.doc = "Matrix @code{[xf, yf, zf; xb, yb, zb]} which holds the \
coordinates (in axes data units) of the point over which the mouse pointer \
was when the mouse button was pressed. If a mouse callback function is \
defined, @code{currentpoint} holds the pointer coordinates at the time \
the mouse button was pressed. For 3-D plots, the first row of the returned \
matrix specifies the point nearest to the current camera position and the \
second row the furthest point. The two points forms a line which is \
perpendicular to the screen.";
s.valid = "2-by-3 matrix";
s.category = "Mouse Interaction";
case "dataaspectratio"
s.doc = "Specify the relative height and width of the data \
displayed in the axes. Setting @code{dataaspectratio} to \
@w{@code{[1, 2]}} causes the length of one unit as displayed on the x-axis \
to be the same as the length of 2 units on the y-axis. \
@xref{XREFdaspect, , daspect function}. __modemsg__";
s.valid = valid_3elvec;
s.category = "Axes Box Appearance";
case "dataaspectratiomode"
s.doc = "Current state of the data aspect ratio mode, either \
manually set by the \
@ref{XREFaxesdataaspectratio, , @w{@qcode{\"dataaspectratio\"} property}} or \
automatically set by Octave in combination with other display properties to \
fit the data in the current view.";
s.category = "Axes Box Appearance";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsize"
s.doc = [doc_fontsize, " __modemsg__"];
s.valid = "scalar";
s.category = "Text Appearance";
case "fontsizemode"
s.doc = "Current state of the fontsize mode, either manually set by \
the @ref{XREFaxesfontsize, , @w{@qcode{\"fontsize\"} property}} or \
automatically set by Octave to maintain readability.";
s.category = "Text Appearance";
case "fontsmoothing"
s.doc = "Control whether any text associated with __objname__ is \
anti-aliased.";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "gridalpha"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Axes Grid Appearance";
case "gridalphamode"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Axes Grid Appearance";
case "gridcolor"
s.doc = "Color of the major grid lines. \
@xref{Colors, , colorspec}. __modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Grid Appearance";
case "gridcolormode"
s.doc = "Current state of the gridcolor mode, either manually set by \
the @ref{XREFaxesgridcolor, , @w{@qcode{\"gridcolor\"} property}} or \
automatically set by Octave to the default value.";
s.category = "Axes Grid Appearance";
case "gridlinestyle"
s.doc = "@xref{Line Styles}.";
s.category = "Axes Grid Appearance";
case "innerposition"
s.doc = "The @qcode{\"innerposition\"} property is the same as the \
@ref{XREFaxesposition, , @w{@qcode{\"position\"} property}}.";
s.valid = valid_4elvec;
s.category = "Axes Grid Appearance";
case "interactions"
s.doc = sprintf (doc_notimpl, "Interaction objects");
s.category = "Callback Execution";
case "labelfontsizemultiplier"
s.doc = "Ratio between the x/y/zlabel fontsize and the tick label \
fontsize.";
s.category = "Text Appearance";
case "layer"
s.doc = "Control whether the axes is drawn below child graphics \
objects (ticks, labels, etc.@: covered by plotted objects) or above.";
s.category = "Axes Box Appearance";
case "layout"
s.doc = sprintf (doc_notimpl, "Tiled and gridded chart layout");
s.category = "Axes Box Appearance";
case "legend"
s.doc = [sprintf(doc_notimpl, "Legend property control"), " Use \
the @ref{XREFlegend, , legend function} to set legend properties."];
s.category = "Text Appearance";
case "linestyleorder"
s.doc = "List of linestyles to be used in order by axes child \
objects, specified as a cell array of line specification strings. Note that \
the linestyle is only incremented after cycling through the full \
@ref{XREFaxescolororder, , @qcode{\"colororder\"}} list. \
@xref{Line Styles}.";
s.category = "Automatic Child Properties";
case "linestyleorderindex"
s.doc = "Index of the next linestyle from the \
@ref{XREFaxeslinestyleorder, , @w{@qcode{\"linestyleorder\"} property}} to \
be used by Axes-child objects.";
s.valid = "whole number scalar";
s.category = "Automatic Child Properties";
case "linewidth"
s.doc = "Width of the main axes lines.";
s.valid = "scalar";
s.category = "Axes Box Appearance";
case "minorgridalpha"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Axes Grid Appearance";
case "minorgridalphamode"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Axes Grid Appearance";
case "minorgridcolor"
s.doc = "Color of the minor grid lines. \
@xref{Colors, , colorspec}. __modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Grid Appearance";
case "minorgridcolormode"
s.doc = "Current state of the minorgridcolor mode, either manually \
set by the \
@ref{XREFaxesminorgridcolor, , @w{@qcode{\"minorgridcolor\"} property}} or \
automatically set by Octave to the default value.";
s.category = "Axes Grid Appearance";
case "minorgridlinestyle"
s.doc = "@xref{Line Styles}.";
s.category = "Axes Grid Appearance";
case "mousewheelzoom"
s.doc = "Fraction of axes limits to zoom for each wheel movement.";
s.valid = "scalar in the range (0, 1)";
s.category = "Mouse Interaction";
case "nextplot"
s.doc = "__prop__ is used by high level plotting functions to \
decide what to do with graphics objects already present in the axes. \
@xref{XREFnewplot, , @w{newplot function}}. The state of __prop__ \
is typically controlled using the @code{hold} function. \
@xref{XREFhold, , @w{hold function}}.";
s.category = "Object Identification";
case "nextseriesindex"
s.doc = "Current index value into the \
@ref{XREFaxescolororder, , \"colororder\"} and \
@ref{XREFaxeslinestyleorder, , \"linestyleorder\"} \
properties, indicating the item that will be used by the next child object";
s.valid = "whole number scalar";
s.category = "Automatic Child Properties";
case "outerposition"
s.doc = "Specify the position of the plot including titles, \
axes, and legend. The four elements of the vector are the \
coordinates of the lower left corner and width and height of the \
plot, in units normalized to the width and height of the plot \
window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
left corner of the axes at @math{(0.2, 0.3)} and the width and \
height to be 0.4 and 0.5 respectively. \
@xref{XREFaxesposition, , @w{position property}}.";
s.valid = valid_4elvec;
s.category = "Object Position";
case "plotboxaspectratio"
s.doc = "@xref{XREFpbaspect, , pbaspect function}. __modemsg__";
s.category = "Object Position";
case "plotboxaspectratiomode"
s.doc = "Current state of the plot box aspect ratio mode, either \
manually set by the \
@ref{XREFaxesdataaspectratio, , @w{@qcode{\"dataaspectratio\"} property}} or \
automatically set by Octave in combination with other display properties to \
fit the data in the current view.";
s.category = "Object Position";
case "position"
if (strcmp (objname, "legend"))
s.doc = "Specify the position of the legend excluding its title. \
The four elements of the vector are the coordinates of the lower left corner \
and width and height of the legend. Changing this property also \
switches the @qcode{\"location\"} to @qcode{\"none\"}.";
s.printdefault = false;
else
s.doc = "Specify the position of the plot excluding titles, \
axes, and legend. The four elements of the vector are the \
coordinates of the lower left corner and width and height of the \
plot, in units normalized to the width and height of the plot \
window. For example, @code{[0.2, 0.3, 0.4, 0.5]} sets the lower \
left corner of the axes at @math{(0.2, 0.3)} and the width and \
height to be 0.4 and 0.5 respectively. \
@xref{XREFaxesouterposition, , @w{outerposition property}}.";
endif
s.valid = valid_4elvec;
s.category = "Object Position";
case "positionconstraint"
s.doc = "Specify which of @qcode{\"innerposition\"} or \
@qcode{\"outerposition\"} properties takes precedence when axes \
annotations extent changes. \
@xref{XREFaxesinnerposition, , @w{@qcode{\"innerposition\"} property}}, \
and @ref{XREFaxesouterposition, , @w{@qcode{\"outerposition\"} property}}.";
s.category = "Object Position";
case "projection"
s.doc = sprintf (doc_notimpl, "Orthographic/perspective projection \
adjustment");
s.category = "Camera and View Controls";
case "sortmethod"
s.doc = sprintf (doc_notimpl, "Child display order control");
s.category = "Parent/Children";
case "tickdir"
s.doc = "Control whether axes tick marks project @qcode{\"in\"} to \
the plot box or @qcode{\"out\"}. The value @qcode{\"both\"} will draw tick \
marks both in and out. The value @qcode{\"none\"} means no tick marks will \
be drawn, although tick labels will still be rendered. __modemsg__ Note \
that the default is @qcode{\"in\"} for 2-D and @qcode{\"out\"} for 3-D \
plots.";
s.category = "Axes Box Appearance";
case "tickdirmode"
s.doc = "Current state of the tickdir mode, either manually set by \
the @ref{XREFaxestickdir, , @w{@qcode{\"tickdir\"} property}} or \
automatically set to the default for the current view.";
s.category = "Axes Box Appearance";
case "ticklabelinterpreter"
s.doc = "Control the way x/y/zticklabel properties are interpreted.\n\
@xref{Use of the \"interpreter\" Property, , @w{Use of the @qcode{\"interpreter\"} Property}}.";
s.category = "Text Appearance";
case "ticklength"
s.doc = "Two-element vector @code{[2Dlen 3Dlen]} specifying the \
length of the tickmarks relative to the longest visible axis.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";
case "tightinset"
s.doc = "Size of the @code{[left bottom right top]} margins around \
the axes that enclose labels and title annotations.";
s.valid = valid_4elvec;
s.printdefault = false;
s.category = "Text Appearance";
case "title"
s.doc = "Graphics handle of the title text object.";
s.valid = valid_handle;
s.category = "Object Identification";
case "titlefontsizemultiplier"
s.doc = "Ratio between the title fontsize and the tick label \
fontsize.";
s.valid = "positive scalar";
s.category = "Text Appearance";
case "titlefontweight"
s.doc = "Control variant of base font used for the axes title.";
s.category = "Text Appearance";
case "toolbar"
s.doc = [sprintf(doc_notimpl, "AxesToolbar objects")];
s.category = "Axes Box Appearance";
case "units"
if (strcmp (objname, "legend"))
s.doc = "Units used to interpret the @qcode{\"position\"} \
property.";
else
s.doc = "Units used to interpret the @qcode{\"position\"}, \
@qcode{\"outerposition\"}, and @qcode{\"tightinset\"} properties.";
endif
s.category = "Object Position";
case "view"
s.doc = "Two-element vector @code{[azimuth elevation]} specifying \
the viewpoint for three-dimensional plots.";
s.valid = valid_2elvec;
s.category = "Camera and View Controls";
case "xaxis"
s.doc = [sprintf(doc_notimpl, "Axes Ruler objects")];
s.category = "Axes Box Appearance";
case "xaxislocation"
s.doc = "Control the x-axis location.";
s.category = "Axes Box Appearance";
case "xcolor"
s.doc = "Color of the x-axis. @xref{Colors, , colorspec}. \
__modemsg__";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Box Appearance";
case "xcolormode"
s.doc = "Current state of the setting determining the color that is \
applied to the x-axis grid lines. If set to @qcode{\"auto\"} and/or the \
@ref{XREFaxesgridcolormode, , @w{@qcode{\"gridcolormode\"} property}} is set \
to @qcode{\"manual\"}, the x-axis grid color will be defined by the \
@ref{XREFaxesgridcolor, , @w{@qcode{\"gridcolor\"} property}}. Otherwise \
the x-axis grid color will be defined by the \
@ref{XREFaxesxcolor, , @w{@qcode{\"xcolor\"} property}}.";
s.category = "Axes Box Appearance";
case "xdir"
s.doc = "Direction of the x axis: @qcode{\"normal\"} is left to \
right in default 2-D and 3-D views.";
s.category = "Axes Box Appearance";
case "xgrid"
s.doc = "Control whether major x grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "xlabel"
s.doc = "Graphics handle of the x label text object.";
s.valid = valid_handle;
s.category = "Text Appearance";
case "xlim"
s.doc = "Two-element vector @code{[xmin xmax]} specifying the limits \
for the x-axis. __modemsg__ @xref{XREFxlim, , @w{xlim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";
case "xlimitmethod"
s.doc = "Method used to determine the x-axis limits when the \
@code{xlimmode} property is @qcode{\"auto\"}. The default value, \
@qcode{\"tickaligned\"} makes limits align with the closest ticks. With \
value @qcode{\"tight\"} the limits are adjusted to enclose all the graphics \
objects in the axes, while with value @qcode{\"padded\"}, an additional \
margin of about 7%% of the data extent is added around the objects. \
@xref{XREFaxis, , @w{axis function}}.";
s.category = "Axes Box Appearance";
case "xlimmode"
s.doc = "Current state of the x-axis limit selection method, either \
manually set with the @ref{XREFaxesxlim, , @w{@qcode{\"xlim\"} property}} \
or automatically set to span the plotted data according to the \
@ref{XREFaxesxlimitmethod, , @w{@qcode{\"xlimitmethod\"} property}}.";
s.category = "Axes Box Appearance";
case "xminorgrid"
s.doc = "Control whether minor x grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "xminortick"
s.doc = "Control whether minor x tick marks are displayed.";
s.category = "Axes Box Appearance";
case "xscale"
s.doc = "Set the x-axis to a linear or logarithmic scale.";
s.category = "Axes Grid Appearance";
case "xtick"
s.doc = "Position of x tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";
case "xticklabel"
s.doc = "Labels of x tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";
case "xticklabelmode"
s.doc = "Setting to determine whether the xtick labels are set \
automatically by Octave or manually using the \
@ref{XREFaxesxticklabel, , @w{@qcode{\"xticklabel\"} property}}.";
s.category = "Text Appearance";
case "xticklabelrotation"
s.doc = [sprintf(doc_notimpl, "Axis label rotation")];
s.category = "Text Appearance";
case "xtickmode"
s.doc = "Setting to determine whether the xtick locations and \
spacing are set automatically by Octave or manually using the \
@ref{XREFaxesxtick, , @w{@qcode{\"xtick\"} property}}.";
s.category = "Axes Box Appearance";
case "yaxis"
s.doc = [sprintf(doc_notimpl, "Axes Ruler objects")];
s.category = "Axes Box Appearance";
case "yaxislocation"
s.doc = "Control the y-axis location.";
s.category = "Axes Box Appearance";
case "ycolor"
s.doc = "Color of the y-axis. @xref{Colors, , colorspec}.";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Box Appearance";
case "ycolormode"
s.doc = "Current state of the setting determining the color that is \
applied to the y-axis grid lines. If set to @qcode{\"auto\"} and/or the \
@ref{XREFaxesgridcolormode, , @w{@qcode{\"gridcolormode\"} property}} is set \
to @qcode{\"manual\"}, the y-axis grid color will be defined by the \
@ref{XREFaxesgridcolor, , @w{@qcode{\"gridcolor\"} property}}. Otherwise \
the y-axis grid color will be defined by the \
@ref{XREFaxesycolor, , @w{@qcode{\"ycolor\"} property}}.";
s.category = "Axes Box Appearance";
case "ydir"
s.doc = "Direction of the y-axis: @qcode{\"normal\"} is bottom \
to top in 2-D and front to back in 3-D default views.";
s.category = "Axes Box Appearance";
case "ygrid"
s.doc = "Control whether major y grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "ylabel"
s.doc = "Graphics handle of the y label text object.";
s.valid = valid_handle;
s.category = "Text Appearance";
case "ylim"
s.doc = "Two-element vector @code{[ymin ymax]} specifying the limits \
for the y-axis. __modemsg__ @xref{XREFylim, , @w{ylim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";
case "ylimitmethod"
s.doc = "Method used to determine the y-axis limits when the \
@code{xlimmode} property is @qcode{\"auto\"}. The default value, \
@qcode{\"tickaligned\"} makes limits align with the closest ticks. With \
value @qcode{\"tight\"} the limits are adjusted to enclose all the graphics \
objects in the axes, while with value @qcode{\"padded\"}, an additional \
margin of about 7%% of the data extent is added around the objects. \
@xref{XREFaxis, , @w{axis function}}.";
s.category = "Axes Box Appearance";
case "ylimmode"
s.doc = "Current state of the y-axis limit selection method, either \
manually set with the @ref{XREFaxesylim, , @w{@qcode{\"ylim\"} property}} \
or automatically set to span the plotted data according to the \
@ref{XREFaxesylimitmethod, , @w{@qcode{\"ylimitmethod\"} property}}.";
s.category = "Axes Box Appearance";
case "yminorgrid"
s.doc = "Control whether minor y grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "yminortick"
s.doc = "Control whether minor y tick marks are displayed.";
s.category = "Axes Grid Appearance";
case "yscale"
s.doc = "Set the y-axis to a linear or logarithmic scale.";
s.category = "Axes Grid Appearance";
case "ytick"
s.doc = "Position of y tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";
case "yticklabel"
s.doc = "Labels of y tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";
case "yticklabelmode"
s.doc = "Setting to determine whether the ytick labels are set \
automatically by Octave or manually using the \
@ref{XREFaxesyticklabel, , @w{@qcode{\"yticklabel\"} property}}.";
s.category = "Text Appearance";
case "yticklabelrotation"
s.doc = [sprintf(doc_notimpl, "Axis label rotation")];
s.category = "Text Appearance";
case "ytickmode"
s.doc = "Setting to determine whether the ytick locations and \
spacing are set automatically by Octave or manually using the \
@ref{XREFaxesytick, , @w{@qcode{\"ytick\"} property}}.";
s.category = "Axes Box Appearance";
case "zaxis"
s.doc = [sprintf(doc_notimpl, "Axes Ruler objects")];
s.category = "Axes Box Appearance";
case "zcolor"
s.doc = "Color of the z-axis. @xref{Colors, , colorspec}.";
s.valid = packopt ({markdef(valid_color), "@qcode{\"none\"}"});
s.category = "Axes Box Appearance";
case "zcolormode"
s.doc = "Current state of the setting determining the color that is \
applied to the z-axis grid lines. If set to @qcode{\"auto\"} and/or the \
@ref{XREFaxesgridcolormode, , @w{@qcode{\"gridcolormode\"} property}} is set \
to @qcode{\"manual\"}, the z-axis grid color will be defined by the \
@ref{XREFaxesgridcolor, , @w{@qcode{\"gridcolor\"} property}}. Otherwise \
the z-axis grid color will be defined by the \
@ref{XREFaxeszcolor, , @w{@qcode{\"zcolor\"} property}}.";
s.category = "Axes Box Appearance";
case "zdir"
s.doc = "Direction of the y-axis: @qcode{\"normal\"} is bottom \
to top in default 3-D views.";
s.category = "Axes Box Appearance";
case "zgrid"
s.doc = "Control whether major z grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "zlabel"
s.doc = "Graphics handle of the z label text object.";
s.valid = valid_handle;
s.category = "Text Appearance";
case "zlim"
s.doc = "Two-element vector @code{[zmin zmax]} specifying the limits \
for the z-axis. __modemsg__ @xref{XREFzlim, , @w{zlim function}}.";
s.valid = valid_2elvec;
s.category = "Axes Box Appearance";
case "zlimitmethod"
s.doc = "Method used to determine the z-axis limits when the \
@code{xlimmode} property is @qcode{\"auto\"}. The default value, \
@qcode{\"tickaligned\"} makes limits align with the closest ticks. With \
value @qcode{\"tight\"} the limits are adjusted to enclose all the graphics \
objects in the axes, while with value @qcode{\"padded\"}, an additional \
margin of about 7%% of the data extent is added around the objects. \
@xref{XREFaxis, , @w{axis function}}.";
s.category = "Axes Box Appearance";
case "zlimmode"
s.doc = "Current state of the z-axis limit selection method, either \
manually set with the @ref{XREFaxeszlim, , @w{@qcode{\"zlim\"} property}} \
or automatically set to span the plotted data according to the \
@ref{XREFaxeszlimitmethod, , @w{@qcode{\"zlimitmethod\"} property}}.";
s.category = "Axes Box Appearance";
case "zminorgrid"
s.doc = "Control whether minor z grid lines are displayed.";
s.category = "Axes Grid Appearance";
case "zminortick"
s.doc = "Control whether minor z tick marks are displayed.";
s.category = "Axes Box Appearance";
case "zscale"
s.doc = "Set the z-axis to a linear or logarithmic scale.";
s.category = "Axes Grid Appearance";
case "ztick"
s.doc = "Position of z tick marks. __modemsg__";
s.valid = "vector";
s.printdefault = false;
s.category = "Axes Box Appearance";
case "zticklabel"
s.doc = "Labels of z tick marks. __modemsg__";
s.valid = valid_cellstring;
s.category = "Text Appearance";
case "zticklabelmode"
s.doc = "Setting to determine whether the ztick labels are set \
automatically by Octave or manually using the \
@ref{XREFaxeszticklabel, , @w{@qcode{\"zticklabel\"} property}}.";
s.category = "Text Appearance";
case "zticklabelrotation"
s.doc = [sprintf(doc_notimpl, "Axis label rotation")];
s.category = "Text Appearance";
case "ztickmode"
s.doc = "Setting to determine whether the ztick locations and \
spacing are set automatically by Octave or manually using the \
@ref{XREFaxesztick, , @w{@qcode{\"ztick\"} property}}.";
s.category = "Axes Box Appearance";
## Legend specific properties
case "autoupdate"
s.doc = "Control whether the number of legend items is updated \
automatically when objects are added to (or deleted from) the peer axes.\n\
For example:\n\
@example\n\
@group\n\
## Create a single plot with its legend.\n\
figure ();\n\
plot (1:10);\n\
legend (\"Slope 1\");\n\
## Add another plot and specify its displayname so that\n\
## the legend is correctly updated.\n\
hold on;\n\
plot ((1:10) * 2, \"displayname\", \"Slope 2\");\n\
## Stop automatic updates for further plots.\n\
legend (\"autoupdate\", \"off\");\n\
plot ((1:10) * 3);\n\
@end group\n\
@end example";
s.category = "Layout";
case "edgecolor"
s.doc = "Control the color of the legend outline.";
s.valid = valid_color;
s.category = "Legend Appearance";
case "itemhitfcn"
s.doc = "Callback function which is executed when a legend item \
is clicked. @xref{Callbacks, , @w{Callbacks section}}.\n\
\n\
The callback function must have the following prototype \
@code{fcn (hlegend, evnt)}, where @code{hlegend} is the legend object handle \
and @code{evnt} is a structure with the following fields:\n\
@table @code\n\
@item Peer\n\
Handle of the plot object to which the clicked item is associated.\n\
@item Region\n\
May be @qcode{\"icon\"} or @qcode{\"label\"} depending on which part of \
the item is clicked.\n\
@item SelectionType\n\
One of @qcode{\"normal\"}, @qcode{\"extend\"}, @qcode{\"open\"}, or \
@qcode{\"alt\"}. \
@xref{XREFfigureselectiontype, , @w{Figure @qcode{\"selectiontype\"}}}.\n\
@item Source\n\
Handle of the legend object.\n\
@item EventName\n\
Name is @qcode{\"ItemHit\"}.\n\
@end table";
s.category = "Callback Execution";
case "location"
s.doc = "Control the location of the legend.";
s.category = "Object Position";
case "numcolumns"
s.doc = "Control the number of columns used in the layout of the \
legend items. \
For example:\n\
@example\n\
@group\n\
figure ();\n\
plot (rand (30));\n\
legend (\"numcolumns\", 3);\n\
@end group\n\
@end example\n\
__modemsg__";
s.valid = "scalar integer";
s.category = "Layout";
case "orientation"
s.doc = "Control whether the legend items are arranged vertically \
(column-wise) or horizontally (row-wise).";
s.category = "Layout";
case "string"
s.doc = "List of labels for the legend items. For example:\n\
@example\n\
@group\n\
figure ();\n\
plot (rand (20));\n\
## Let legend choose names automatically\n\
hl = legend ();\n\
## Selectively change some names\n\
str = get (hl, \"string\");\n\
str(1:5:end) = \"Garbage\";\n\
set (hl, \"string\", str);\n\
@end group\n\
@end example";
s.valid = valid_cellstring;
s.printdefault = false;
s.category = "Text Appearance";
case "textcolor"
s.doc = "Control the color of the text strings for legend items.";
s.valid = valid_color;
s.category = "Text Appearance";
case "textposition"
s.doc = "Control whether text strings are displayed on the left or \
right of their corresponding icon.";
s.category = "Text Appearance";
endswitch
## Line properties
elseif (strcmp (objname, "line"))
switch (field)
## Overridden shared properties
case "children"
s.doc = sprintf (doc_notimpl, "Child objects for lines");
## Use base category.
## Specific properties
case "color"
s.doc = "Color of the line object. @xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Line Appearance";
case "displayname"
s.doc = "Text for the legend entry corresponding to this line.";
s.valid = valid_cellstring;
s.category = "Legend Options";
case "linestyle"
s.doc = "@xref{Line Styles}.";
s.category = "Line Appearance";
case "linewidth"
s.doc = "Width of the line object measured in points.";
s.valid = "scalar";
s.category = "Line Appearance";
case "linejoin"
s.doc = "Control the shape of the junction of line segments. \
This property currently only affects the printed output.";
s.category = "Line Appearance";
case "marker"
s.doc = "Shape of the marker for each data point. \
@xref{Marker Styles}.";
s.category = "Marker Appearance";
case "markeredgecolor"
s.doc = "Color of the edge of the markers. When set to \
@qcode{\"auto\"}, the marker edges have the same color as the line. If set \
to @qcode{\"none\"}, no marker edges are displayed. This property can also \
be set to any color. @xref{Colors, , colorspec}.";
s.category = "Marker Appearance";
case "markerfacecolor"
s.doc = "Color of the face of the markers. When set to \
@qcode{\"auto\"}, the marker faces have the same color as the line. If set \
to @qcode{\"none\"}, the marker faces are not displayed. This property \
can also be set to any color. @xref{Colors, , colorspec}.";
s.category = "Marker Appearance";
case "markersize"
s.doc = "Size of the markers measured in points.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "xdata"
s.doc = "Vector of x data to be plotted.";
s.valid = "vector";
s.category = "Coordinate Data";
case "xdatasource"
s.doc = "Name of a vector in the current base workspace to use as \
x data.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "ydata"
s.doc = "Vector of y data to be plotted.";
s.valid = "vector";
s.category = "Coordinate Data";
case "ydatasource"
s.doc = "Name of a vector in the current base workspace to use as \
y data.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "zdata"
s.doc = "Vector of z data to be plotted.";
s.valid = "vector";
s.category = "Coordinate Data";
case "zdatasource"
s.doc = "Name of a vector in the current base workspace to use as \
z data.";
s.valid = valid_string;
s.category = "Coordinate Data";
endswitch
## Text properties
elseif (strcmp (objname, "text"))
switch (field)
## Overridden shared properties
case "children"
s.doc = ["__objname__ objects have no child objects. ", doc_unused];
## Use base category.
## Specific properties
case "backgroundcolor"
s.doc = "Color of the background area. @xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Text Box Appearance";
case "color"
s.doc = "Color of the text. @xref{Colors, ,colorspec}.";
s.valid = valid_color;
s.category = "Text Appearance";
case "edgecolor"
s.doc = "Color of the outline of the background area. \
@xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Text Box Appearance";
case "editing"
s.doc = sprintf (doc_notimpl, "Interactive text editing");
s.category = "Text Appearance";
case "extent"
s.doc = "Vector @code{[x0 y0 width height]} indicating the size and \
location of the text string.";
s.valid = valid_4elvec;
s.printdefault = false;
s.category = "Object Position";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsmoothing"
s.doc = "Control whether anti-aliasing is used when rendering text.";
s.category = "Text Appearance";
case "fontsize"
s.doc = doc_fontsize;
s.valid = "scalar";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "horizontalalignment"
s.doc = "Specifies the horizontal location of the point set by the \
@ref{XREFtextposition, , @w{@qcode{\"position\"} property}} relative to the \
text.";
s.category = "Object Position";
case "interpreter"
s.doc = "Control the way the @qcode{\"string\"} property is \
interpreted.\n\
@xref{Use of the \"interpreter\" Property, , @w{Use of the @qcode{\"interpreter\"} Property}}.";
s.category = "Text Appearance";
case "linestyle"
s.doc = "Style of the text box outline. @xref{Line Styles}.";
s.category = "Text Box Appearance";
case "linewidth"
s.doc = "Width of the text box outline.";
s.valid = "scalar";
s.category = "Text Box Appearance";
case "margin"
s.doc = "Margins between the borders of the background area \
and the texts. The value is currently interpreted as pixels, regardless \
of the @qcode{\"fontunits\"} property.";
s.valid = "scalar";
s.category = "Text Box Appearance";
case "position"
s.doc = "Vector @code{[X0 Y0 Z0]} where X0, Y0, and Z0 indicate the \
position of the text anchor as defined by @code{verticalalignment} and \
@code{horizontalalignment}.";
s.valid = valid_3elvec;
s.category = "Object Position";
case "rotation"
s.doc = "The angle of rotation for the displayed text, measured in \
degrees.";
s.valid = "scalar";
s.category = "Object Position";
case "string"
s.doc = "The __objname__ object string content.";
s.valid = valid_string;
s.category = "Text Appearance";
case "units"
s.doc = "Sets the measurement unit or method applied to the \
@ref{XREFtextposition, , @qcode{\"position\"}} and \
@ref{XREFtextextent, , @qcode{\"extent\"}} properties. The default \
option @qcode{\"data\"} uses the same units and limits as the data plotted in \
the figure. The @qcode{\"normalized\"} option applies a unitless 0 to 1 scale \
to the limits along each axis of the displayed data.";
s.category = "Object Position";
case "verticalalignment"
s.doc = "Specifies the vertical location of the point set by the \
@ref{XREFtextposition, , @w{@qcode{\"position\"} property}} relative to the \
text. Note that @qcode{\"top\"} and @qcode{\"bottom\"} align to the edge of \
the text box while @qcode{\"cap\"} and @qcode{\"baseline\"} refer to the edges \
of the text itself.";
s.category = "Object Position";
endswitch
## Image properties
elseif (strcmp (objname, "image"))
switch (field)
## Overridden shared properties
case "children"
s.doc = sprintf (doc_notimpl, "Child objects of Images");
## Use base category.
## Specific properties
case "alphadata"
s.doc = sprintf (doc_notimpl, "Transparency");
s.valid = valid_scalmat;
s.category = "Image Data";
case "alphadatamapping"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Image Data";
case "cdata"
s.doc = "Color data for the image object. Data is either stored as \
a 2-D matrix where each element's value determines that pixel's color \
according to the current colormap, or as a 3-D array where the third \
dimension contains separate red, blue, and green components for each pixel. \
For RGB arrays, the values that map to minimum and maximum color value \
depend on the class of @qcode{\"cdata\"}. Floating point and logical values \
range from 0 to 1 while integer value range from @code{intmin} to \
@code{intmax} for that integer class.";
s.valid = "array";
s.category = "Image Data";
case "cdatamapping"
s.doc = "Sets the method for mapping data from the \
@ref{XREFimagecdata, , @w{@qcode{\"cdata\"} property}} to the current \
colormap. @qcode{\"Direct\"} mapping selects the color using the \
@qcode{\"cdata\"} value as an index to the current colormap. \
@qcode{\"Scaled\"} mapping scales the @qcode{\"cdata\"} values to the range \
specified in the @ref{XREFaxesclim, , @w{@qcode{\"clim\"} axes property}}.";
s.category = "Image Data";
case "displayname"
s.doc = "Text for the legend entry corresponding to this image.";
s.valid = valid_cellstring;
s.category = "Legend Options";
case "xdata"
s.doc = "Two-element vector @code{[xfirst xlast]} specifying the x \
coordinates of the centers of the first and last columns of the image.\n\
\n\
Setting @code{xdata} to the empty matrix ([]) will restore the default value \
of @code{[1 columns(image)]}.";
s.valid = valid_2elvec;
s.category = "Image Data";
case "ydata"
s.doc = "Two-element vector @code{[yfirst ylast]} specifying the y \
coordinates of the centers of the first and last rows of the image.\n\
\n\
Setting @code{ydata} to the empty matrix ([]) will restore the default value \
of @code{[1 rows(image)]}.";
s.valid = valid_2elvec;
s.category = "Image Data";
endswitch
## Surface properties
elseif (strcmp (objname, "surface"))
switch (field)
## Overridden shared properties
case "children"
s.doc = sprintf (doc_notimpl, "Child objects for Surfaces");
## Use base category.
## Specific properties
case "alphadata"
s.doc = sprintf (doc_notimpl, "Transparency");
s.valid = valid_scalmat;
s.category = "Color and Transparency";
case "alphadatamapping"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "ambientstrength"
s.doc = "Strength of the ambient light. Value between 0.0 and 1.0.";
s.valid = "scalar";
s.category = "Lighting";
case "backfacelighting"
s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
@qcode{\"reverselit\"}: The normals are always oriented towards the point of \
view. @qcode{\"unlit\"}: Faces with normals pointing away from the point of \
view are unlit.";
s.category = "Lighting";
case "cdata"
s.doc = "Color data values for __objname__ vertices. Data is stored \
either as a 2-D matrix the same size as \
@ref{XREFsurfacezdata, , @qcode{\"zdata\"}} where each element's value \
determines that vertex's color according to the current colormap, or as a \
3-D array where the third dimension contains separate red, blue, and green \
components for each vertex.";
s.valid = "array";
s.category = "Color and Transparency";
case "cdatamapping"
s.doc = "Sets the method for mapping data from the \
@ref{XREFsurfacecdata, , @w{@qcode{\"cdata\"} property}} to the current \
colormap. @qcode{\"Direct\"} mapping selects the color using the \
@qcode{\"cdata\"} value as an index to the current colormap. \
@qcode{\"Scale\"} mapping scales the @qcode{\"cdata\"} values to the range \
specified in the @ref{XREFaxesclim, , @w{@qcode{\"clim\"} axes property}}.";
s.category = "Color and Transparency";
case "cdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFsurfacecdata, , @w{@qcode{\"cdata\"} property}}. Data is \
transferred into @qcode{\"cdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Color and Transparency";
case "diffusestrength"
s.doc = "Strength of the diffuse reflection. Value between 0.0 (no \
diffuse reflection) and 1.0 (full diffuse reflection).";
s.valid = "scalar";
s.category = "Lighting";
case "displayname"
s.doc = "Text for the legend entry corresponding to this surface.";
s.category = "Legend Options";
case "edgealpha"
s.doc = sprintf (doc_notimpl, "Transparency");
s.valid = "scalar";
s.category = "Outline Appearance";
case "edgecolor"
s.doc = "Color of the edges of the __objname__ object, specified as \
either a valid color specification or one of @qcode{\"none\"}, \
@qcode{\"flat\"}, or @qcode{\"interp\"}. @qcode{\"flat\"} and \
@qcode{\"interp\"} will set either a single color for each edge or a color \
interpolated between two adjacent vertices using the color value data stored \
in @ref{XREFsurfacecdata, , @qcode{\"cdata\"}}. \
@xref{Colors, , colorspec}.";
s.valid = packopt ({valid_color, ...
"@qcode{\"none\"}", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}"});
s.category = "Outline Appearance";
case "edgelighting"
s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
of the object are drawn with light and shadow effects. Supported values are \
@qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (faceted look), and \
@qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
@qcode{\"gouraud\"}.";
s.category = "Outline Appearance";
case "facealpha"
s.doc = "Transparency level of the faces of the surface object. Only \
double values are supported at present where a value of 0 means complete \
transparency and a value of 1 means solid faces without transparency. Setting \
the property to @qcode{\"flat\"}, @qcode{\"interp\"} or @qcode{\"texturemap\"} \
causes the faces to not being rendered. Additionally, the faces are not \
sorted from back to front which might lead to unexpected results when \
rendering layered transparent faces.";
s.valid = packopt ({"scalar", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}", ...
"@qcode{\"texturemap\"}"});
s.category = "Faces Appearance";
case "facecolor"
s.doc = "Color of the faces of the __objname__ object, specified as \
either a valid color specification or one of @qcode{\"none\"}, \
@qcode{\"flat\"}, or @qcode{\"interp\"}. @qcode{\"flat\"} and \
@qcode{\"interp\"} will set either a single color for each face or a color \
interpolated across the face's vertices using the color value data stored in \
@ref{XREFsurfacecdata, , @qcode{\"cdata\"}}. \
@xref{Colors, , colorspec}.";
s.valid = packopt ({valid_color, ...
"@qcode{\"none\"}", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}"});
s.category = "Faces Appearance";
case "facelighting"
s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
of the object are drawn with light and shadow effects. Supported values are \
@qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (faceted look), and \
@qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
@qcode{\"gouraud\"}.";
s.category = "Faces Appearance";
case "facenormals"
s.doc = "Face normals are used for lighting the edges or faces if the \
@code{edgelighting} or @code{facelighting} properties are set to \
@qcode{\"flat\"}. __modemsg__";
s.category = "Faces Appearance";
case "facenormalsmode"
s.doc = "If this property is set to @qcode{\"auto\"}, \
@code{facenormals} are automatically calculated if the @code{edgelighting} or \
@code{facelighting} property are set to @qcode{\"flat\"} and at least one \
@code{light} object is present and visible in the same axes.";
s.category = "Faces Appearance";
case "linestyle"
s.doc = "@xref{Line Styles}.";
s.category = "Outline Appearance";
case "linewidth"
s.doc = "@xref{XREFlinelinewidth, , @w{line linewidth property}}.";
s.valid = "scalar";
s.category = "Outline Appearance";
case "marker"
s.doc = "@xref{Marker Styles}.";
s.category = "Marker Appearance";
case "markeredgecolor"
s.doc = "@xref{XREFlinemarkeredgecolor, , \
@w{line markeredgecolor property}}.";
s.category = "Marker Appearance";
case "markerfacecolor"
s.doc = "@xref{XREFlinemarkerfacecolor, , \
@w{line markerfacecolor property}}.";
s.category = "Marker Appearance";
case "markersize"
s.doc = "@xref{XREFlinemarkersize, , \
@w{line markersize property}}.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "meshstyle"
s.doc = "Specifies whether to display the edges associated with the \
surface data's rows, columns, or both.";
s.category = "Outline Appearance";
case "specularcolorreflectance"
s.doc = "Reflectance for specular color. Value between 0.0 (color \
of underlying face) and 1.0 (color of light source).";
s.valid = "scalar";
s.category = "Lighting";
case "specularexponent"
s.doc = "Exponent for the specular reflection. The lower the value, \
the more the reflection is spread out.";
s.valid = "scalar";
s.category = "Lighting";
case "specularstrength"
s.doc = "Strength of the specular reflection. Value between 0.0 (no \
specular reflection) and 1.0 (full specular reflection).";
s.valid = "scalar";
s.category = "Lighting";
case "vertexnormals"
s.doc = "Vertex normals are used for lighting the edges or faces if \
the @code{edgelighting} or @code{facelighting} properties are set to \
@qcode{\"gouraud\"}. __modemsg__";
s.category = "Lighting";
case "vertexnormalsmode"
s.doc = "If this property is set to @qcode{\"auto\"}, \
@code{vertexnormals} are automatically calculated if the @code{edgelighting} \
or @code{facelighting} property are set to @qcode{\"gouraud\"} and at least \
one @code{light} object is present and visible in the same axes.";
s.category = "Lighting";
case "xdata"
s.doc = "Data for the x-coordinate.";
s.valid = "matrix";
s.category = "Coordinate Data";
case "xdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFsurfacexdata, , @w{@qcode{\"xdata\"} property}}. Data is \
transferred into @qcode{\"xdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "ydata"
s.doc = "Data for the y-coordinate.";
s.valid = "matrix";
s.category = "Coordinate Data";
case "ydatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFsurfaceydata, , @w{@qcode{\"ydata\"} property}}. Data is \
transferred into @qcode{\"ydata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "zdata"
s.doc = "Data for the z-coordinate.";
s.valid = "matrix";
s.category = "Coordinate Data";
case "zdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFsurfacezdata, , @w{@qcode{\"zdata\"} property}}. Data is \
transferred into @qcode{\"zdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
endswitch
## Patch properties
elseif (strcmp (objname, "patch"))
switch (field)
## Overridden shared properties
case "children"
s.doc = sprintf (doc_notimpl, "Child objects for Patch objects");
## Use base category.
## Specific properties
case "alphadatamapping"
s.doc = sprintf (doc_notimpl, "Transparency");
s.category = "Color and Transparency";
case "ambientstrength"
s.doc = "Strength of the ambient light. Value between 0.0 and 1.0.";
s.valid = "scalar";
s.category = "Lighting";
case "backfacelighting"
s.doc = "@qcode{\"lit\"}: The normals are used as is for lighting. \
@qcode{\"reverselit\"}: The normals are always oriented towards the point of \
view. @qcode{\"unlit\"}: Faces with normals pointing away from the point of \
view are unlit.";
s.category = "Lighting";
case "cdata"
s.doc = "Data defining the patch object color relative to its \
x/y/z-coordinate data. Patch color can be defined using indices into the \
current colormap or as RGB triplets, where the RGB colors are defined along \
the third dimension. These colors can be separately defined for the entire \
patch object, for individual faces, or for individual vertices, and is \
determined by the shape of @qcode{\"cdata\"} as follows:\n\
\n\
If @qcode{\"cdata\"} is a scalar index into the current colormap or a 1-by-1-by-3 \
RGB triplet, it defines the color of all faces and edges.\n\
\n\
If the patch object has N faces, and @qcode{\"cdata\"} is a 1-by-N vector of \
colormap indices or a 1-by-N-by-3 RGB array, it defines the color of each \
face.\n\
\n\
If the patch object has N faces and M vertices per face, and @code{cdata} is \
a M-by-N matrix of colormap indices or a M-by-N-by-3 RGB array, it defines \
the color at each vertex. (The shape of @qcode{\"cdata\"} should match that of \
@ref{XREFpatchxdata,,@qcode{\"xdata\"}}, \
@ref{XREFpatchydata,,@qcode{\"ydata\"}}, and \
@ref{XREFpatchzdata,,@qcode{\"zdata\"}}.)";
s.valid = valid_scalmatarr;
s.category = "Color and Transparency";
case "cdatamapping"
s.doc = "Sets the method for mapping data from the \
@ref{XREFpatchcdata, , @qcode{\"cdata\"}} or \
@ref{XREFpatchcdata, , @qcode{\"cdata\"}} property to the current \
colormap. @qcode{\"Direct\"} mapping selects the color using the \
@qcode{\"cdata\"} or @qcode{\"facevertexcdata\"} value as an index to the \
current colormap. @qcode{\"Scaled\"} mapping scales the @qcode{\"cdata\"} \
or @qcode{\"facevertexcdata\"} values to the range \
specified in the @ref{XREFaxesclim, , @w{@qcode{\"clim\"} axes property}}.";
s.category = "Color and Transparency";
case "diffusestrength"
s.doc = "Strength of the diffuse reflection. Value between 0.0 (no \
diffuse reflection) and 1.0 (full diffuse reflection).";
s.valid = "scalar";
s.category = "Lighting";
case "displayname"
s.doc = "Text of the legend entry corresponding to this patch.";
s.category = "Legend Options";
case "edgealpha"
s.doc = sprintf (doc_notimpl, "Transparency");
s.valid = valid_scalmat;
s.category = "Outline Appearance";
case "edgecolor"
s.doc = "Color of the edges of the __objname__ object, specified as \
either a valid color specification or one of @qcode{\"none\"}, \
@qcode{\"flat\"}, or @qcode{\"interp\"}. @qcode{\"flat\"} and \
@qcode{\"interp\"} will set either a single color for each edge or a color \
interpolated between edge's vertices using the color value data stored in \
@ref{XREFpatchcdata, , @qcode{\"cdata\"}}. \
@xref{Colors, , colorspec}.";
s.valid = packopt ({valid_color, ...
"@qcode{\"none\"}", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}"});
s.category = "Outline Appearance";
case "edgelighting"
s.doc = "When set to a value other than @qcode{\"none\"}, the edges \
of the object are drawn with light and shadow effects. Supported values are \
@qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (faceted look), and \
@qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
@qcode{\"gouraud\"}.";
s.category = "Outline Appearance";
case "facealpha"
s.doc = "Transparency level of the faces of the patch object. Only \
double values are supported at present where a value of 0 means complete \
transparency and a value of 1 means solid faces without transparency. Setting \
the property to @qcode{\"flat\"} or @qcode{\"interp\"} causes the faces to not \
being rendered. Additionally, the faces are not sorted from back to front \
which might lead to unexpected results when rendering layered transparent \
faces.";
s.valid = packopt ({"scalar", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}"});
s.category = "Color and Transparency";
case "facecolor"
s.doc = "Color of the faces of the __objname__ object, specified as \
either a valid color specification or one of @qcode{\"none\"}, \
@qcode{\"flat\"}, or @qcode{\"interp\"}. @qcode{\"flat\"} and \
@qcode{\"interp\"} will set either a single color for each face or a color \
interpolated across the face's vertices using the color value data stored in \
either the @ref{XREFpatchcdata, , @qcode{\"cdata\"}} or \
@ref{XREFpatchfacevertexcdata, , @qcode{\"facevertexcdata\"}} \
properties. @xref{Colors, , colorspec}.";
## Don't provide a default value, and mark colorspec with
## braces, this forces the default RGB triplet to be displayed
s.valid = packopt ({markdef(valid_color), ...
"@qcode{\"none\"}", ...
"@qcode{\"flat\"}", ...
"@qcode{\"interp\"}"});
s.category = "Color and Transparency";
case "facelighting"
s.doc = "When set to a value other than @qcode{\"none\"}, the faces \
of the object are drawn with light and shadow effects. Supported values are \
@qcode{\"none\"} (no lighting effects), @qcode{\"flat\"} (faceted look), and \
@qcode{\"gouraud\"} (linear interpolation of the lighting effects between \
the vertices). @qcode{\"phong\"} is deprecated and has the same effect as \
@qcode{\"gouraud\"}.";
s.category = "Color and Transparency";
case "facenormals"
s.doc = "Face normals are used for lighting the edges or faces if the \
@code{edgelighting} or @code{facelighting} properties are set to \
@qcode{\"flat\"}. __modemsg__";
s.category = "Lighting";
case "facenormalsmode"
s.doc = "If this property is set to @qcode{\"auto\"}, \
@code{facenormals} are automatically calculated if the @code{edgelighting} or \
@code{facelighting} property are set to @qcode{\"flat\"} and at least one \
@code{light} object is present and visible in the same axes.";
s.category = "Lighting";
case "faces"
s.doc = "__objname__ faces connectivity list stored as an M x N \
matrix, with each of the M faces defined by a row of up to N vertices, \
and each element contains the row index of a vertex stored in the \
@ref{XREFpatchvertices, , @w{vertices property}}. Faces with fewer than N \
vertices use NaN values to fill empty row elements.";
s.valid = valid_vecmat;
s.category = "Coordinate Data";
case "facevertexalphadata"
s.doc = sprintf (doc_notimpl, "Face-Vertex transparency control");
s.category = "Color and Transparency";
case "facevertexcdata"
s.doc = "Data defining the patch object color relative to its \
face-vertex data. Patch color can be defined using indices into the \
current colormap or as RGB triplets, where the RGB colors are defined in the \
rows of @qcode{\"facevertexcdata\"}. These colors can be separately defined \
for the entire patch object, for individual faces, or for individual vertices, \
and is determined by the shape of @qcode{\"facevertexcdata\"} as follows:\n\
\n\
If @code{facevertexcdata} is a scalar index into the current colormap or a \
1-by-3 RGB triplet, it defines the color of all faces and edges.\n\
\n\
If the patch object has N faces, and @code{facevertexcdata} is a N-by-1 column \
vector of indices or a N-by-3 RGB matrix, it defines the color of each one \
of the N faces.\n\
\n\
If the patch object has M vertices, and @code{facevertexcdata} is a M-by-1 \
column vector of indices or a M-by-3 RGB matrix, it defines the color at \
each vertex.";
s.valid = valid_scalmat;
s.category = "Color and Transparency";
case "linestyle"
s.doc = "@xref{Line Styles}.";
s.category = "Outline Appearance";
case "linewidth"
s.doc = "@xref{XREFlinelinewidth, , @w{line linewidth property}}.";
s.valid = "scalar";
s.category = "Outline Appearance";
case "marker"
s.doc = "@xref{XREFlinemarker, , @w{line marker property}}.";
s.category = "Marker Appearance";
case "markeredgecolor"
s.doc = "@xref{XREFlinemarkeredgecolor, , \
@w{line markeredgecolor property}}.";
s.category = "Marker Appearance";
case "markerfacecolor"
s.doc = "@xref{XREFlinemarkerfacecolor, , \
@w{line markerfacecolor property}}.";
s.category = "Marker Appearance";
case "markersize"
s.doc = "@xref{XREFlinemarkersize, , @w{line markersize property}}.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "specularcolorreflectance"
s.doc = "Reflectance for specular color. Value between 0.0 (color \
of underlying face) and 1.0 (color of light source).";
s.valid = "scalar";
s.category = "Lighting";
case "specularexponent"
s.doc = "Exponent for the specular reflection. The lower the value, \
the more the reflection is spread out.";
s.valid = "scalar";
s.category = "Lighting";
case "specularstrength"
s.doc = "Strength of the specular reflection. Value between 0.0 (no \
specular reflection) and 1.0 (full specular reflection).";
s.valid = "scalar";
s.category = "Lighting";
case "vertexnormals"
s.doc = "Vertex normals are used for lighting the edges or faces if \
the @code{edgelighting} or @code{facelighting} properties are set to \
@qcode{\"gouraud\"}. __modemsg__";
s.category = "Lighting";
case "vertexnormalsmode"
s.doc = "If this property is set to @qcode{\"auto\"}, \
@code{vertexnormals} are automatically calculated if the @code{edgelighting} \
or @code{facelighting} property are set to @qcode{\"gouraud\"} and at least \
one @code{light} object is present and visible in the same axes.";
s.category = "Lighting";
case "vertices"
s.doc = "__objname__ vertex list stored as an N x 3 matrix, with \
each row containing the x, y, and z coordinates of the vector, and used \
with the @ref{XREFpatchfaces, , @w{faces property}} to define patch \
structure.";
s.valid = valid_vecmat;
s.category = "Coordinate Data";
case "xdata"
s.doc = "__objname__ vertex x-coordinates.";
s.valid = valid_vecmat;
s.category = "Coordinate Data";
case "ydata"
s.doc = "__objname__ vertex y-coordinates.";
s.valid = valid_vecmat;
s.category = "Coordinate Data";
case "zdata"
s.doc = "__objname__ vertex z-coordinates.";
s.valid = valid_vecmat;
s.category = "Coordinate Data";
endswitch
## Scatter properties
elseif (strcmp (objname, "scatter"))
switch (field)
## Overridden shared properties
case "children"
s.doc = sprintf (doc_notimpl, "Child objects for Scatter plots");
## Use base category.
## Specific properties
case "annotation"
s.doc = sprintf (doc_notimpl, "Legend appearance toggling from within \
the __objname__ object");
s.category = "Legend Options";
case "cdata"
s.doc = "Data defining the scatter object color.\n\
\n\
If @code{cdata} is a scalar index into the current colormap or a RGB triplet, \
it defines the color of all scatter markers.\n\
\n\
If @code{cdata} is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, \
it defines the color of each one of the N scatter markers.";
s.valid = valid_scalmat;
s.category = "Color Data";
case "cdatamode"
s.doc = "If @code{cdatamode} is @qcode{\"auto\"}, @code{cdata} is set \
to the color from the @code{colororder} of the ancestor axes corresponding to \
the @code{seriesindex}.";
s.category = "Color Data";
case "cdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFpatchcdata, , @w{@qcode{\"cdata\"} property}}. Data is \
transferred into @qcode{\"cdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Color Data";
case "datatiptemplate"
s.doc = sprintf (doc_notimpl, "Data tip objects");
s.category = "Mouse Interaction";
case "displayname"
s.doc = "Text of the legend entry corresponding to this scatter \
object.";
s.category = "Legend Options";
case "latitudedata"
s.doc = sprintf (doc_notimpl, "Geographic coordinate scatter plotting");
s.category = "Coordinate Data";
case "latitudedatasource"
s.doc = sprintf (doc_notimpl, "Geographic coordinate scatter plotting");
s.category = "Coordinate Data";
case "linewidth"
s.doc = "Line width of the edge of the markers.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "longitudedata"
s.doc = sprintf (doc_notimpl, "Geographic coordinate scatter plotting");
s.category = "Coordinate Data";
case "longitudedatasource"
s.doc = sprintf (doc_notimpl, "Geographic coordinate scatter plotting");
s.category = "Coordinate Data";
case "marker"
s.doc = "@xref{XREFlinemarker, , @w{line marker property}}.";
s.category = "Marker Appearance";
case "markeredgealpha"
s.doc = "Transparency level of the faces of the markers where a \
value of 0 means complete transparency and a value of 1 means solid faces \
without transparency. Note that the markers are not sorted from back to \
front which might lead to unexpected results when rendering layered \
transparent markers or in combination with other transparent objects.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "markeredgecolor"
s.doc = "Color of the edge of the markers. @qcode{\"none\"} means \
that the edges are transparent and @qcode{\"flat\"} means that the value \
from @code{cdata} is used. @xref{XREFlinemarkeredgecolor, , \
@w{line markeredgecolor property}}.";
s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
"@qcode{\"flat\"}", ...
valid_color});
s.category = "Marker Appearance";
case "markerfacealpha"
s.doc = "Transparency level of the faces of the markers where a \
value of 0 means complete transparency and a value of 1 means solid faces \
without transparency. Note that the markers are not sorted from back to \
front which might lead to unexpected results when rendering layered \
transparent markers or in combination with other transparent objects.";
s.valid = "scalar";
s.category = "Marker Appearance";
case "markerfacecolor"
s.doc = "Color of the face of the markers. @qcode{\"none\"} means \
that the faces are transparent, @qcode{\"flat\"} means that the value from \
@code{cdata} is used, and @qcode{\"auto\"} uses the @code{color} property of \
the ancestor axes. @xref{XREFlinemarkerfacecolor, , \
@w{line markerfacecolor property}}.";
s.valid = packopt ({markdef("@qcode{\"none\"}"), ...
"@qcode{\"flat\"}", ...
"@qcode{\"auto\"}", ...
valid_color});
s.category = "Marker Appearance";
case "rdata"
s.doc = sprintf (doc_notimpl, "Polar coordinates for scatter plotting");
s.category = "Coordinate Data";
case "rdatasource"
s.doc = sprintf (doc_notimpl, "Polar coordinates for scatter plotting");
s.category = "Coordinate Data";
case "seriesindex"
s.doc = "Each scatter object in the same axes is assigned an \
incrementing integer. This corresponds to the index into the \
@code{colororder} of the ancestor axes that is used if @code{cdatamode} is \
set to @qcode{\"auto\"}.";
s.category = "Color Data";
case "sizedata"
s.doc = "Size of the area of the marker. A scalar value applies to \
all markers. If @code{cdata} is an N-by-1 vector, it defines the color of \
each one of the N scatter markers.";
s.valid = packopt ({"[]", "scalar", "vector"});
s.category = "Marker Appearance";
case "sizedatasource"
s.doc = sprintf (doc_notimpl, "Data from workspace variables");
s.category = "Marker Appearance";
case "thetadata"
s.doc = sprintf (doc_notimpl, "Polar coordinates for scatter plotting");
s.category = "Coordinate Data";
case "thetadatasource"
s.doc = sprintf (doc_notimpl, "Polar coordinates for scatter plotting");
s.category = "Coordinate Data";
case "xdata"
s.doc = "Vector with the x coordinates of the scatter object.";
s.valid = "vector";
s.category = "Coordinate Data";
case "xdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFscatterxdata, , @w{@qcode{\"xdata\"} property}}. Data is \
transferred into @qcode{\"xdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "ydata"
s.doc = "Vector with the y coordinates of the scatter object.";
s.valid = "vector";
s.category = "Coordinate Data";
case "ydatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFscatterydata, , @w{@qcode{\"ydata\"} property}}. Data is \
transferred into @qcode{\"ydata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
case "zdata"
s.doc = "For 3D data, vector with the y coordinates of the scatter \
object.";
s.valid = packopt ({"[]", "vector"});
s.category = "Coordinate Data";
case "zdatasource"
s.doc = "The name of a workspace variable that contains data that \
will be used for the \
@ref{XREFscatterzdata, , @w{@qcode{\"zdata\"} property}}. Data is \
transferred into @qcode{\"zdata\"} using the \
@ref{XREFrefreshdata, , @w{refreshdata function}}.";
s.valid = valid_string;
s.category = "Coordinate Data";
endswitch
## Light properties
elseif (strcmp (objname, "light"))
switch (field)
## Overridden shared properties
case "children"
s.doc = ["__objname__ objects have no child objects. ", doc_unused];
## Use base category.
## Specific properties
case "color"
s.doc = "Color of the light source. @xref{Colors, ,colorspec}.";
s.valid = valid_color;
s.category = "Lighting";
case "position"
s.doc = "Position of the light source.";
s.category = "Lighting";
case "style"
s.doc = "This string defines whether the light emanates from a \
light source at infinite distance (@qcode{\"infinite\"}) or from a local \
point source (@qcode{\"local\"}).";
s.category = "Lighting";
endswitch
## uimenu properties
elseif (strcmp (objname, "uimenu"))
switch (field)
## Overridden shared properties
case "buttondownfcn"
s.doc = doc_unused;
## Use base category.
## Specific properties
case "accelerator"
s.doc = "A character that when pressed together with CTRL will \
execute this menu entry (e.g., @qcode{\"x\"} for @code{CTRL+x}).";
s.valid = "character";
s.category = "Keyboard Interaction";
case "callback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this menu item is selected.";
s.valid = "string";
s.category = "Callback Execution";
case "checked"
s.doc = "Sets whether or not a mark appears at this menu entry.";
s.category = "Menu Options";
case "enable"
s.doc = "Sets whether this menu entry is active or is grayed out.";
s.category = "Menu Options";
case "foregroundcolor"
s.doc = "The color value of the text for this menu entry.";
s.valid = valid_color;
s.category = "Appearance";
case "menuselectedfcn"
s.doc = "Function that is called when this menu item is executed. \
__fcnmsg__";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "position"
s.doc = "A scalar value containing the relative menu position from \
the left or top depending on the orientation of the menu.";
s.valid = "scalar";
s.category = "Object Position";
case "separator"
s.doc = "State indicating whether a separator line will be drawn \
above the current menu position.";
s.category = "Appearance";
case "text"
s.doc = "The text for this menu entry. A @qcode{\"&\"} character \
can be used to mark the \
@ref{XREFuimenuaccelerator, , @w{@qcode{\"accelerator\"} key}}";
s.valid = "string";
s.category = "Menu Options";
endswitch
## uicontextmenu properties
elseif (strcmp (objname, "uicontextmenu"))
switch (field)
## Overridden shared properties
case "buttondownfcn"
s.doc = doc_unused;
## Use base category.
## Specific properties
case "callback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this item is selected.";
s.valid = "string";
s.category = "Callback Execution";
case "position"
s.doc = sprintf (doc_notimpl, "Manually setting location for \
uicontextmenu to appear");
s.category = "Object Position";
endswitch
## uipanel properties
elseif (strcmp (objname, "uipanel"))
switch (field)
## Overridden shared properties
## Specific properties
case "backgroundcolor"
s.doc = "The color value of the background of this panel.";
s.valid = valid_color;
s.category = "Appearance";
case "bordertype"
s.doc = "Sets whether or not a line border will surround the panel.";
s.category = "Appearance";
case "borderwidth"
s.doc = "The width of the line border in pixels.";
s.valid = "whole number scalar";
s.category = "Appearance";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsize"
s.doc = doc_fontsize;
s.valid = "scalar";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "foregroundcolor"
s.doc = "The color value of the title text for this panel.";
s.valid = valid_color;
s.category = "Appearance";
case "highlightcolor"
s.doc = "The color value of the line bordering this panel.";
s.valid = valid_color;
s.category = "Appearance";
case "position"
s.doc = "Size of the panel represented as the four-element vector \
[left, bottom, width, height].";
s.valid = valid_4elvec;
s.category = "Object Position";
case "resizefcn"
s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "shadowcolor"
s.doc = "The color value of the line surrounding the border line \
around this panel. @xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Appearance";
case "sizechangedfcn"
s.doc = "Callback triggered when the panel size is changed.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "title"
s.doc = "The text for the panel title.";
s.valid = "string";
s.category = "Text Appearance";
case "titleposition"
s.doc = "Relative position of the title within the panel.";
s.category = "Text Appearance";
case "units"
s.doc = "Unit of measurement used to interpret the \
@qcode{\"position\"} property.";
s.category = "Object Position";
endswitch
## uibuttongroup properties
elseif (strcmp (objname, "uibuttongroup"))
switch (field)
## Overridden shared properties
## Specific properties
case "backgroundcolor"
s.doc = "The color value of the background of this buttongroup.";
s.valid = valid_color;
s.category = "Appearance";
case "bordertype"
s.doc = "Sets whether or not a line border will surround the \
buttongroup.";
s.category = "Appearance";
case "borderwidth"
s.doc = "The width of the line border in pixels.";
s.valid = "whole number scalar";
s.category = "Appearance";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsize"
s.doc = doc_fontsize;
s.valid = "scalar";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "foregroundcolor"
s.doc = "The color value of the title text for this buttongroup.";
s.valid = valid_color;
s.category = "Appearance";
case "highlightcolor"
s.doc = "The color value of the line bordering this buttongroup.";
s.valid = valid_color;
s.category = "Appearance";
case "position"
s.doc = "Size of the buttongroup represented as the four-element \
vector [left, bottom, width, height].";
s.valid = valid_4elvec;
s.category = "Object Position";
case "resizefcn"
s.doc = "__prop__ is deprecated. Use @code{sizechangedfcn} instead.";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "selectedobject"
s.doc = "Graphic handle of the currently selected item in the \
buttongroup.";
s.category = "Button Group Operation";
case "selectionchangedfcn"
s.doc = "Callback triggered when the selected item within the \
buttongroup is changed.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "shadowcolor"
s.doc = "The color value of the line surrounding the border line \
around this buttongroup.";
s.valid = valid_color;
s.category = "Appearance";
case "sizechangedfcn"
s.doc = "Callback triggered when the buttongroup size is changed.\
\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Appearance";
case "title"
s.doc = "The text for the buttongroup title.";
s.valid = "string";
s.category = "Text Appearance";
case "titleposition"
s.doc = "Relative position of the title within the buttongroup.";
s.category = "Text Appearance";
case "units"
s.doc = "Unit of measurement used to interpret the \
@qcode{\"position\"} property.";
s.category = "Object Position";
endswitch
## uicontrol properties
elseif (strcmp (objname, "uicontrol"))
switch (field)
## Overridden shared properties
## Specific properties
case "backgroundcolor"
s.doc = "The color value of the background of this control object.";
s.valid = valid_color;
s.category = "Appearance";
case "callback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this control is activated.";
s.valid = "string";
s.category = "Callback Execution";
case "cdata"
s.doc = "Image data used to represent the control object, stored as \
a M x N x 3 RGB array.";
s.valid = "array";
s.category = "Appearance";
case "enable"
s.doc = "Sets whether this control object is active or is grayed \
out.";
s.category = "Control Options";
case "extent"
s.doc = "Size of the text string associated to the uicontrol \
returned in the form @code{[0 0 width height]} (the two first elements \
are always zero).\n\n\
For multi-line strings the returned @code{width} and @code{height} \
indicate the size of the rectangle enclosing all lines.";
s.valid = valid_4elvec;
s.printdefault = false;
s.category = "Appearance";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsize"
s.doc = doc_fontsize;
s.valid = "scalar";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "foregroundcolor"
s.doc = "The color value of the text for this control object. \
@xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Appearance";
case "horizontalalignment"
s.doc = "Specifies the horizontal justification of the text within \
the uicontrol object.";
s.category = "Text Appearance";
case "keypressfcn"
s.doc = "Function that is executed when a key is pressed and \
the control object has focus.\n\n__fcnmsg__";
s.valid = valid_fcn;
s.category = "Callback Execution";
case "listboxtop"
s.doc = "The index of the string option that will appear at the top of \
\"listbox\" controls ";
s.valid = "scalar";
s.category = "Control Options";
case "max"
s.doc = "The maximum control value, whose effect on the control is \
dependent on the control type. For @qcode{\"checkbox\"}, \
@qcode{\"togglebutton\"}, and @qcode{\"radiobutton\"} controls, the \
@qcode{\"max\"} value is assigned to the @qcode{\"value\"} property when the \
control object is selected. For @qcode{\"slider\"} controls, \
@qcode{\"max\"} defines the maximum value of the slider. For \
@qcode{\"edit\"} and @qcode{\"listbox\"} controls, if @code{Max - Min > 1}, \
then the control will permit multiple line entries or list item selections, \
respectively.";
s.valid = "scalar";
s.category = "Control Options";
case "min"
s.doc = "The minimum control value, whose effect on the control is \
dependent on the control type. For @qcode{\"checkbox\"}, \
@qcode{\"togglebutton\"}, and @qcode{\"radiobutton\"} controls, the \
@qcode{\"min\"} value is assigned to the @qcode{\"value\"} property when the \
control object is not selected. For @qcode{\"slider\"} controls, \
@qcode{\"min\"} defines the minimum value of the slider. For \
@qcode{\"edit\"} and @qcode{\"listbox\"} controls, if @code{Max - Min > 1}, \
then the control will permit multiple line entries or list item selections, \
respectively.";
s.valid = "scalar";
s.category = "Control Options";
case "position"
s.doc = "Size of the control object represented as the four-element \
vector [left, bottom, width, height].";
s.valid = valid_4elvec;
s.category = "Object Position";
case "sliderstep"
s.doc = "The fractional step size, measured relative to the \
@code{Min - Max} span of the slider, that the slider moves when the user \
clicks on the object. @qcode{\"sliderstep\"} is specified as a two-element \
vector consisting of @code{[minor major]}, where @qcode{\"minor\"} is the \
step size for clicking on the slider arrows, and @qcode{\"major\"} is the \
step size for clicking within the slider bar.";
s.valid = valid_2elvec;
s.category = "Control Options";
case "string"
s.doc = "The text appearing with the control object.";
s.valid = "string";
s.category = "Text Appearance";
case "style"
s.doc = "The type of control object created. For a complete \
description of available control styles, see the \
@ref{XREFuicontrol, , @w{@qcode{\"uicontrol\"} function}}";
s.category = "Appearance";
case "tooltipstring"
s.doc = "A text string that appears in a tooltip when the mouse \
pointer hovers over the control object.";
s.valid = "string";
s.category = "Mouse Interaction";
case "units"
s.doc = "Unit of measurement used to interpret the \
@qcode{\"position\"} property.";
s.category = "Object Position";
case "value"
s.doc = "A numerical value associated with the current state of the \
control object, with the meaning of the value dependent on the \"style\" of \
the control object.";
s.valid = "scalar";
s.category = "Control Options";
case "verticalalignment"
s.doc = "Specifies the vertical position of the text in the \
uicontrol object.";
s.category = "Text Appearance";
endswitch
## uitable Properties
elseif (strcmp (objname, "uitable"))
switch (field)
## Overridden shared properties
## Specific properties
case "backgroundcolor"
s.doc = "Color of the background of the table specified as a \
3-element RBG vector. If __prop__ has multiple rows, the colors cycle \
repeatedly if the \
@ref{XREFuitablerowstriping, , @qcode{\"rowstriping\"} property} is on.";
s.valid = valid_color;
s.category = "Appearance";
case "celleditcallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever a table cell is edited.";
s.valid = "string";
s.category = "Callback Execution";
case "cellselectioncallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever a table cell is selected.";
s.valid = "string";
s.category = "Callback Execution";
case "columneditable"
s.doc = "A logical indicator of whether the columns are editable. \
It consists of either a 1 x N vector of logical values where true or false \
indicate the corresponding column is or is not editable, respectively, or \
an empty logical array indicating that no column is editable.";
s.valid = "logical row vector";
s.category = "Table Operation";
case "columnformat"
s.doc = "The display format for numeric data in each column. \
Valid formats include @qcode{\"char\"}, @qcode{\"logical\"}, \
@qcode{\"numeric\"}, or a valid format setting from the \
@ref{XREFformat, , format function}";
s.category = "Table Data";
case "columnname"
s.doc = "Column names specified as either @qcode{\"numbered\"} or a \
1 x N cell string vector containing the names to be used for each column \
heading.";
s.category = "Table Data";
case "columnwidth"
s.doc = "Setting for determining width of each column, valid \
options include: @qcode{\"auto\"}, @qcode{\"fit\"}, evenly divided \
multiples specified as @qcode{\"1x\"}, @qcode{\"2x\"}, etc., or a 1 x N cell \
vector where each element corresponds to one of N table columns, and \
containing any of the above options or a fixed width specified in pixels.";
s.category = "Table Data";
case "data"
s.doc = "The data contained in the table specified as either a \
2-D numeric, logical, or cell array.";
s.valid = "matrix";
s.category = "Table Data";
case "enable"
s.doc = "Sets whether this table object is active or is grayed out.";
s.category = "Table Operation";
case "extent"
s.doc = "A for element vector indicating the size of the table. \
The first two elements of the array are always zero, while the third and \
fourth elements contain the height and width of the table.";
s.valid = valid_4elvec;
s.printdefault = false;
s.category = "Object Position";
case "fontangle"
s.doc = doc_fontangle;
s.category = "Text Appearance";
case "fontname"
s.doc = doc_fontname;
s.valid = valid_string;
s.category = "Text Appearance";
case "fontsize"
s.doc = doc_fontsize;
s.valid = "scalar";
s.category = "Text Appearance";
case "fontunits"
s.doc = doc_fontunits;
s.category = "Text Appearance";
case "fontweight"
s.doc = doc_fontweight;
s.category = "Text Appearance";
case "foregroundcolor"
s.doc = "Color of the data text in this table. \
@xref{Colors, , colorspec}.";
s.valid = valid_color;
s.category = "Appearance";
case "keypressfcn"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever a key is pressed in this table object.";
s.valid = "string";
s.category = "Callback Execution";
case "keyreleasefcn"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever a key is released in this table object.";
s.category = "Callback Execution";
case "position"
s.doc = "The position and size of the table. The four elements of \
the vector are the coordinates of the lower left corner and width and height \
of the figure. @xref{XREFuitableunits, , @w{units property}}.";
s.valid = valid_4elvec;
s.category = "Object Position";
case "rearrangeablecolumns"
s.doc = "Indicates whether or not the ability to move columns by \
clicking and dragging the column headers.";
s.category = "Table Operation";
case "rowname"
s.doc = "Row names specified as either @qcode{\"numbered\"} or a \
N x 1 cell string vector containing the names to be used for each row \
heading.";
s.category = "Table Data";
case "rowstriping"
s.doc = "Setting to indicate whether the table background color \
will use different colors for each row. Colors are drawn from the \
@ref{XREFuitablebackgroundcolor, , @qcode{\"backgroundcolor\"} property} in \
a repeating pattern.";
s.category = "Appearance";
case "tooltipstring"
s.doc = "A text string that appears in a tooltip when the mouse \
pointer hovers over the table object.";
s.valid = "string";
s.category = "Mouse Interaction";
case "units"
s.doc = "Unit of measurement used to interpret the \
@qcode{\"position\"} property.";
s.category = "Object Position";
endswitch
## uitoolbar properties
elseif (strcmp (objname, "uitoolbar"))
switch (field)
## Overridden shared properties
case "buttondownfcn"
s.doc = doc_unused;
## Use base category.
endswitch
## uipushtool properties
elseif (strcmp (objname, "uipushtool"))
switch (field)
## Overridden shared properties
case "buttondownfcn"
s.doc = doc_unused;
## Use base category.
## Specific properties
case "__named_icon__"
s.doc = "The name of an bundled icon file to use as the image for \
the pushtool object.";
s.valid = "string";
s.category = "Appearance";
case "cdata"
s.doc = "Image data used to represent the pushtool object, stored as \
a M x N x 3 RGB array.";
s.valid = "array";
s.category = "Appearance";
case "clickedcallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this control object is clicked.";
s.valid = "string";
s.category = "Callback Execution";
case "enable"
s.doc = "Sets whether this pushtool object is active or is \
grayed out.";
s.category = "Pushtool Operation";
case "separator"
s.doc = "State indicating whether a separator line will be drawn \
next to the current pushtool position.";
s.category = "Appearance";
case "tooltipstring"
s.doc = "A text string that appears in a tooltip when the mouse \
pointer hovers over the pushtool object.";
s.valid = "string";
s.category = "Mouse Interaction";
endswitch
## uitoggletool properties
elseif (strcmp (objname, "uitoggletool"))
switch (field)
## Overridden shared properties
case "buttondownfcn"
s.doc = doc_unused;
## Use base category.
## Specific properties
case "__named_icon__"
s.doc = "The name of an bundled icon file to use as the image for \
the toggletool object.";
s.valid = "string";
s.category = "Appearance";
case "cdata"
s.doc = "Image data used to represent the toggletool object, stored \
as a M x N x 3 RGB array.";
s.valid = "array";
s.category = "Appearance";
case "clickedcallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this control object is clicked.";
s.valid = "string";
s.category = "Callback Execution";
case "enable"
s.doc = "Sets whether this toggletool object is active or is grayed \
out.";
s.category = "Toggle Operation";
case "offcallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this control object is toggled off.";
s.valid = "string";
s.category = "Callback Execution";
case "oncallback"
s.doc = "A string consisting of a valid Octave expression that will \
be executed whenever this control object is toggled on.";
s.valid = "string";
s.category = "Callback Execution";
case "separator"
s.doc = "Setting to draw a vertical line to the left of the \
toggletool.";
s.category = "Appearance";
case "state"
s.doc = "The current @qcode{\"on\"} or @qcode{\"off\"} state of the \
toggletool object.";
s.category = "Toggle Operation";
case "tooltipstring"
s.doc = "A text string that appears in a tooltip when the mouse \
pointer hovers over the toggletool object.";
s.valid = "string";
s.category = "Mouse Interaction";
endswitch
endif
## Replace keywords
if (! isempty (s.doc) && ! strcmp (objname, "base"))
s.doc = expand_doc (s.doc, field, objname);
endif
endfunction
function strout = expand_doc (strin, field, objname)
strout = strrep (strin, "__objname__", objname);
strout = strrep (strout, "__prop__", ["@code{" field "}"]);
modemsg = "Setting @code{%s} also forces the @code{%smode} \
property to be set to @qcode{\"manual\"}.";
modemsg = sprintf (modemsg, field, field);
strout = strrep (strout, "__modemsg__", modemsg);
fcnmsg = "For information on how to write graphics listener \
functions see @ref{Callbacks, , @w{Callbacks section}}.";
strout = strrep (strout, "__fcnmsg__", fcnmsg);
endfunction
function s = getstructure (objname, base = [], props = {})
hf = [];
if (! strcmp (objname, "root"))
## Use an improbable number to avoid ishghandle to return true for 1
hf = figure (2265465, "visible", "off");
endif
## Build a default object to extract its properties list and default values.
if (strcmp (objname, "base"))
## Base properties are extracted from hggroup that only have 1 additional
## regular (non-hidden) property, "displayname".
h = hggroup ();
elseif (strcmp (objname, "root"))
h = 0;
elseif (strcmp (objname, "figure"))
h = hf;
elseif (strcmp (objname, "legend"))
line ();
h = legend ();
if (isempty (props))
props = {"autoupdate", "box", "color", "edgecolor", "fontangle", ...
"fontname", "fontsize", "fontunits", "fontweight", ...
"itemhitfcn", "location", "numcolumns", "orientation", ...
"position", "string", "textcolor", "title", "units"};
endif
elseif (strcmp (objname, "scatter"))
## Make sure to get a scatter object independent of graphics toolkit
hax = axes (hf);
h = __go_scatter__ (hax);
else
eval (["h = " objname " ();"]);
endif
gprop = get (h);
sprop = set (h);
if (! isempty (props))
flds = fieldnames (gprop);
idx = cellfun (@(s) ! any (strcmp (props, s)), flds);
gprop = rmfield (gprop, flds(idx));
flds = fieldnames (sprop);
idx = cellfun (@(s) ! any (strcmp (props, s)), flds);
sprop = rmfield (sprop, flds(idx));
endif
fields = fieldnames (gprop);
nf = numel (fields);
args = cell (2*nf, 1);
for ii = 1:nf
field = fields{ii};
## Get hard coded documentation
val = getdoc (objname, field, base);
## Extract the default values that are not hard coded in getdoc
if (isempty (val.default) && val.printdefault)
val.default = getdefault (h, objname, field);
endif
val.isreadonly = ! isfield (sprop, field);
## Extract the valid values that are not hard coded in getdoc
if (! val.isreadonly && isempty (val.valid))
val.valid = sprop.(field);
if (! isempty (val.valid) && iscellstr (val.valid))
## Add double quotes around string radio properties
val.valid = cellfun (@(s) ["@qcode{\"" s "\"}"], val.valid,
"uniformoutput", false);
val.valid = strjoin (val.valid, " | ");
endif
endif
args{2*(ii-1)+1} = field;
args{2*ii} = val;
endfor
## Build struct and remove unused fields in base properties
s = struct (args{:});
if (strcmp (objname, "base"))
s = rmfield (s, "displayname");
endif
if (isfigure (hf))
close (hf)
endif
endfunction
function def = getdefault (h, objname, field)
## This function is meant to be run without initialization file so
## that the properties we get are the default.
def = get (h, field);
## Don't print default values for graphics handles
if (ishghandle (def) && isscalar (def) && def != 0)
def = "";
else
if (ischar (def))
def = ['@qcode{"' def '"}'];
else
if ((isvector (def) && numel (def) < 5) || isempty (def))
## Use disp to print the default value for short vectors and
## empty values
str = disp (def);
str(end) = []; # remove linefeed
str = strtrim (str); # remove leading space
## Add [] around vector values
if (ismatrix (def) && numel (def) > 1)
str = ["[" str "]"];
## Add ";" between columns vector values
if (rows (def) != 1)
str = strrep (str, "\n", "; ");
endif
endif
## Replace texinfo reserved characters
def = strrep (str, "@", "@@"); # must occur first
def = strrep (def, "{", "@{");
def = strrep (def, "}", "@}");
def = ["@code{" def "}"];
else
args = arrayfun (@(x) num2str (x), size (def), "uniformoutput", false);
def = [strjoin(args, "-by-") " " class(def)];
endif
endif
endif
endfunction
function str = printdoc (objname, obj, is_prop_subset)
## File header and beginning of properties table
str = warn_autogen ();
if (strcmp (objname, "root"))
str = sprintf ("%s\n\nProperties of the root graphics object:", str);
elseif (is_prop_subset)
## Do nothing
else
str = sprintf ("%s\n\nProperties of @code{%s} objects (@pxref{XREF%s,,%s}):",
str, objname, objname, objname);
endif
## Sort fields by category, put the special categories "Miscellaneous" and
## "Unused" last if they are used.
allfields = fieldnames (obj);
allcategories = cellfun (@(s) obj.(s).category, allfields, "uni", false);
categories = unique (allcategories);
idx = strcmp (categories, "Miscellaneous");
categories = [categories(!idx); categories(idx)];
idx = strcmp (categories, "Unused");
categories = [categories(!idx); categories(idx)];
## Add links to categories at the top
str = sprintf ("%s\n\n@subsubheading Categories:\n\n", str);
for ii = 1:numel (categories);
str = sprintf ("%s@ref{XREF%scategory%s, , @w{%s}}@: ", str, objname, strrep (categories{ii}, " ", ""), categories{ii});
if (ii < numel (categories))
str = sprintf ("%s| ", str);
endif
endfor
idx = [];
for ii = 1:numel (categories)
fields = sort (allfields(strcmp (allcategories, categories{ii})));
nf = numel (fields);
str = sprintf ("%s\n\n@anchor{XREF%scategory%s}\n", str, ...
objname, strrep (categories{ii}, " ", ""));
str = sprintf ("%s@subsubheading %s\n", str, categories{ii});
str = sprintf ("%s@prindex %s %s\n", str, ...
objname, strrep (categories{ii}, " ", ""));
str = sprintf ("%s\n@table @asis", str);
for jj = 1:nf
field = fields{jj};
str = sprintf ("%s\n\n", str);
if (! is_prop_subset)
## @anchor: cross reference using XREFobjnamefield label
## Concept index: call info from octave with 'doc ("objname field")'
str = sprintf ("%s@anchor{XREF%s%s}\n@prindex %s %s\n",
str, objname, field, objname, field);
endif
## Item
str = sprintf ("%s@item @code{%s}", str, field);
## Mark item read-only if needed
if (obj.(field).isreadonly)
str = sprintf ("%s (read-only):", str);
else
str = sprintf ("%s:", str);
endif
## Print valid and default values
tmp = print_options (obj.(field).valid,
obj.(field).default);
if (! isempty (tmp))
str = sprintf ("%s %s\n", str, tmp);
else
str = sprintf ("%s\n", str);
endif
## Print documentation
str = sprintf ("%s%s\n", str, obj.(field).doc);
endfor
## End of properties table
str = sprintf ("%s\n@end table", str);
endfor
endfunction
function str = warn_autogen ()
str = "@c DO NOT EDIT! Generated automatically by genpropdoc.m.\n\
\n\
@c Copyright (C) 2014-2024 The Octave Project Developers\n\
@c\n\
@c See the file COPYRIGHT.md in the top-level directory of this\n\
@c distribution or <https://octave.org/copyright/>.\n\
@c\n\
@c This file is part of Octave.\n\
@c\n\
@c Octave is free software: you can redistribute it and/or modify it\n\
@c under the terms of the GNU General Public License as published by\n\
@c the Free Software Foundation, either version 3 of the License, or\n\
@c (at your option) any later version.\n\
@c\n\
@c Octave is distributed in the hope that it will be useful, but\n\
@c WITHOUT ANY WARRANTY; without even the implied warranty of\n\
@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\
@c GNU General Public License for more details.\n\
@c\n\
@c You should have received a copy of the GNU General Public License\n\
@c along with Octave; see the file COPYING. If not, see\n\
@c <https://www.gnu.org/licenses/>.";
endfunction
function str = print_options (val, default)
str = "";
if (! isempty (val))
tmp = strrep (val, default, ["@{" default "@}"]);
if (length (tmp) == length (val) && ! isempty (default))
str = [tmp ", def. " default];
else
str = tmp;
endif
elseif (! isempty (default))
str = ["def. " default];
endif
endfunction
|