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
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qtextformat.h"
#include "qtextformat_p.h"
#include <qvariant.h>
#include <qdatastream.h>
#include <qdebug.h>
#include <qmap.h>
#include <qhash.h>
QT_BEGIN_NAMESPACE
/*!
\class QTextLength
\reentrant
\brief The QTextLength class encapsulates the different types of length
used in a QTextDocument.
\ingroup text
When we specify a value for the length of an element in a text document,
we often need to provide some other information so that the length is
used in the way we expect. For example, when we specify a table width,
the value can represent a fixed number of pixels, or it can be a percentage
value. This information changes both the meaning of the value and the way
it is used.
Generally, this class is used to specify table widths. These can be
specified either as a fixed amount of pixels, as a percentage of the
containing frame's width, or by a variable width that allows it to take
up just the space it requires.
\sa QTextTable
*/
/*!
\fn explicit QTextLength::QTextLength()
Constructs a new length object which represents a variable size.
*/
/*!
\fn QTextLength::QTextLength(Type type, qreal value)
Constructs a new length object of the given \a type and \a value.
*/
/*!
\fn Type QTextLength::type() const
Returns the type of length.
\sa QTextLength::Type
*/
/*!
\fn qreal QTextLength::value(qreal maximumLength) const
Returns the effective length, constrained by the type of the length object
and the specified \a maximumLength.
\sa type()
*/
/*!
\fn qreal QTextLength::rawValue() const
Returns the constraint value that is specific for the type of the length.
If the length is QTextLength::PercentageLength then the raw value is in
percent, in the range of 0 to 100. If the length is QTextLength::FixedLength
then that fixed amount is returned. For variable lengths, zero is returned.
*/
/*!
\fn bool QTextLength::operator==(const QTextLength &other) const
Returns true if this text length is the same as the \a other text
length.
*/
/*!
\fn bool QTextLength::operator!=(const QTextLength &other) const
Returns true if this text length is different from the \a other text
length.
*/
/*!
\enum QTextLength::Type
\value VariableLength
\value FixedLength
\value PercentageLength
*/
/*!
Returns the text length as a QVariant
*/
QTextLength::operator QVariant() const
{
return QVariant(QVariant::TextLength, this);
}
QDataStream &operator<<(QDataStream &stream, const QTextLength &length)
{
return stream << qint32(length.lengthType) << double(length.fixedValueOrPercentage);
}
QDataStream &operator>>(QDataStream &stream, QTextLength &length)
{
qint32 type;
double fixedValueOrPercentage;
stream >> type >> fixedValueOrPercentage;
length.fixedValueOrPercentage = fixedValueOrPercentage;
length.lengthType = QTextLength::Type(type);
return stream;
}
class QTextFormatPrivate : public QSharedData
{
public:
QTextFormatPrivate() : hashDirty(true), fontDirty(true), hashValue(0) {}
struct Property
{
inline Property(qint32 k, const QVariant &v) : key(k), value(v) {}
inline Property() {}
qint32 key;
QVariant value;
inline bool operator==(const Property &other) const
{ return key == other.key && value == other.value; }
inline bool operator!=(const Property &other) const
{ return key != other.key || value != other.value; }
};
inline uint hash() const
{
if (!hashDirty)
return hashValue;
return recalcHash();
}
inline bool operator==(const QTextFormatPrivate &rhs) const {
if (hash() != rhs.hash())
return false;
return props == rhs.props;
}
inline void insertProperty(qint32 key, const QVariant &value)
{
hashDirty = true;
if (key >= QTextFormat::FirstFontProperty && key <= QTextFormat::LastFontProperty)
fontDirty = true;
for (int i = 0; i < props.count(); ++i)
if (props.at(i).key == key) {
props[i].value = value;
return;
}
props.append(Property(key, value));
}
inline void clearProperty(qint32 key)
{
for (int i = 0; i < props.count(); ++i)
if (props.at(i).key == key) {
hashDirty = true;
if (key >= QTextFormat::FirstFontProperty && key <= QTextFormat::LastFontProperty)
fontDirty = true;
props.remove(i);
return;
}
}
inline int propertyIndex(qint32 key) const
{
for (int i = 0; i < props.count(); ++i)
if (props.at(i).key == key)
return i;
return -1;
}
inline QVariant property(qint32 key) const
{
const int idx = propertyIndex(key);
if (idx < 0)
return QVariant();
return props.at(idx).value;
}
inline bool hasProperty(qint32 key) const
{ return propertyIndex(key) != -1; }
void resolveFont(const QFont &defaultFont);
inline const QFont &font() const {
if (fontDirty)
recalcFont();
return fnt;
}
QVector<Property> props;
private:
uint recalcHash() const;
void recalcFont() const;
mutable bool hashDirty;
mutable bool fontDirty;
mutable uint hashValue;
mutable QFont fnt;
friend QDataStream &operator<<(QDataStream &, const QTextFormat &);
friend QDataStream &operator>>(QDataStream &, QTextFormat &);
};
static uint variantHash(const QVariant &variant)
{
switch (variant.type()) {
case QVariant::Invalid: return 0;
case QVariant::Bool: return variant.toBool();
case QVariant::Int: return variant.toInt();
case QVariant::Double: return static_cast<int>(variant.toDouble());
case QVariant::String: return qHash(variant.toString());
case QVariant::Color: return qHash(qvariant_cast<QColor>(variant).rgb());
default: break;
}
return qHash(variant.typeName());
}
uint QTextFormatPrivate::recalcHash() const
{
hashValue = 0;
for (QVector<Property>::ConstIterator it = props.constBegin(); it != props.constEnd(); ++it)
hashValue += (it->key << 16) + variantHash(it->value);
hashDirty = false;
return hashValue;
}
void QTextFormatPrivate::resolveFont(const QFont &defaultFont)
{
recalcFont();
const uint oldMask = fnt.resolve();
fnt = fnt.resolve(defaultFont);
if (hasProperty(QTextFormat::FontSizeAdjustment)) {
const qreal scaleFactors[7] = {qreal(0.7), qreal(0.8), qreal(1.0), qreal(1.2), qreal(1.5), qreal(2), qreal(2.4)};
const int htmlFontSize = qBound(0, property(QTextFormat::FontSizeAdjustment).toInt() + 3 - 1, 6);
if (defaultFont.pointSize() <= 0) {
qreal pixelSize = scaleFactors[htmlFontSize] * defaultFont.pixelSize();
fnt.setPixelSize(qRound(pixelSize));
} else {
qreal pointSize = scaleFactors[htmlFontSize] * defaultFont.pointSizeF();
fnt.setPointSizeF(pointSize);
}
}
fnt.resolve(oldMask);
}
void QTextFormatPrivate::recalcFont() const
{
// update cached font as well
QFont f;
for (int i = 0; i < props.count(); ++i) {
switch (props.at(i).key) {
case QTextFormat::FontFamily:
f.setFamily(props.at(i).value.toString());
break;
case QTextFormat::FontPointSize:
f.setPointSizeF(props.at(i).value.toDouble());
break;
case QTextFormat::FontPixelSize:
f.setPixelSize(props.at(i).value.toInt());
break;
case QTextFormat::FontWeight: {
int weight = props.at(i).value.toInt();
if (weight == 0) weight = QFont::Normal;
f.setWeight(weight);
break; }
case QTextFormat::FontItalic:
f.setItalic(props.at(i).value.toBool());
break;
case QTextFormat::FontUnderline:
if (! hasProperty(QTextFormat::TextUnderlineStyle)) // don't use the old one if the new one is there.
f.setUnderline(props.at(i).value.toBool());
break;
case QTextFormat::TextUnderlineStyle:
f.setUnderline(static_cast<QTextCharFormat::UnderlineStyle>(props.at(i).value.toInt()) == QTextCharFormat::SingleUnderline);
break;
case QTextFormat::FontOverline:
f.setOverline(props.at(i).value.toBool());
break;
case QTextFormat::FontStrikeOut:
f.setStrikeOut(props.at(i).value.toBool());
break;
case QTextFormat::FontLetterSpacing:
f.setLetterSpacing(QFont::PercentageSpacing, props.at(i).value.toDouble());
break;
case QTextFormat::FontWordSpacing:
f.setWordSpacing(props.at(i).value.toDouble());
break;
case QTextFormat::FontCapitalization:
f.setCapitalization(static_cast<QFont::Capitalization> (props.at(i).value.toInt()));
break;
case QTextFormat::FontFixedPitch: {
const bool value = props.at(i).value.toBool();
if (f.fixedPitch() != value)
f.setFixedPitch(value);
break; }
case QTextFormat::FontStyleHint:
f.setStyleHint(static_cast<QFont::StyleHint>(props.at(i).value.toInt()), f.styleStrategy());
break;
case QTextFormat::FontStyleStrategy:
f.setStyleStrategy(static_cast<QFont::StyleStrategy>(props.at(i).value.toInt()));
break;
case QTextFormat::FontKerning:
f.setKerning(props.at(i).value.toBool());
break;
default:
break;
}
}
fnt = f;
fontDirty = false;
}
Q_GUI_EXPORT QDataStream &operator<<(QDataStream &stream, const QTextFormat &fmt)
{
stream << fmt.format_type << fmt.properties();
return stream;
}
Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt)
{
QMap<qint32, QVariant> properties;
stream >> fmt.format_type >> properties;
// QTextFormat's default constructor doesn't allocate the private structure, so
// we have to do this, in case fmt is a default constructed value.
if(!fmt.d)
fmt.d = new QTextFormatPrivate();
for (QMap<qint32, QVariant>::ConstIterator it = properties.constBegin();
it != properties.constEnd(); ++it)
fmt.d->insertProperty(it.key(), it.value());
return stream;
}
/*!
\class QTextFormat
\reentrant
\brief The QTextFormat class provides formatting information for a
QTextDocument.
\ingroup text
\ingroup shared
A QTextFormat is a generic class used for describing the format of
parts of a QTextDocument. The derived classes QTextCharFormat,
QTextBlockFormat, QTextListFormat, and QTextTableFormat are usually
more useful, and describe the formatting that is applied to
specific parts of the document.
A format has a \c FormatType which specifies the kinds of thing it
can format; e.g. a block of text, a list, a table, etc. A format
also has various properties (some specific to particular format
types), as described by the Property enum. Every property has a
corresponding Property.
The format type is given by type(), and the format can be tested
with isCharFormat(), isBlockFormat(), isListFormat(),
isTableFormat(), isFrameFormat(), and isImageFormat(). If the
type is determined, it can be retrieved with toCharFormat(),
toBlockFormat(), toListFormat(), toTableFormat(), toFrameFormat(),
and toImageFormat().
A format's properties can be set with the setProperty() functions,
and retrieved with boolProperty(), intProperty(), doubleProperty(),
and stringProperty() as appropriate. All the property IDs used in
the format can be retrieved with allPropertyIds(). One format can
be merged into another using merge().
A format's object index can be set with setObjectIndex(), and
retrieved with objectIndex(). These methods can be used to
associate the format with a QTextObject. It is used to represent
lists, frames, and tables inside the document.
\sa {Text Processing Classes}
*/
/*!
\enum QTextFormat::FormatType
\value InvalidFormat
\value BlockFormat
\value CharFormat
\value ListFormat
\value TableFormat
\value FrameFormat
\value UserFormat
*/
/*!
\enum QTextFormat::Property
\value ObjectIndex
Paragraph and character properties
\value CssFloat
\value LayoutDirection The layout direction of the text in the document
(Qt::LayoutDirection).
\value OutlinePen
\value ForegroundBrush
\value BackgroundBrush
\value BackgroundImageUrl
Paragraph properties
\value BlockAlignment
\value BlockTopMargin
\value BlockBottomMargin
\value BlockLeftMargin
\value BlockRightMargin
\value TextIndent
\value TabPositions Specifies the tab positions. The tab positions are structs of QTextOption::Tab which are stored in
a QList (internally, in a QList<QVariant>).
\value BlockIndent
\value BlockNonBreakableLines
\value BlockTrailingHorizontalRulerWidth
Character properties
\value FontFamily
\value FontPointSize
\value FontSizeAdjustment Specifies the change in size given to the fontsize already set using
FontPointSize or FontPixelSize.
\omitvalue FontSizeIncrement
\value FontWeight
\value FontItalic
\value FontUnderline \e{This property has been deprecated.} Use QTextFormat::TextUnderlineStyle instead.
\value FontOverline
\value FontStrikeOut
\value FontFixedPitch
\value FontPixelSize
\value FontCapitalization Specifies the capitalization type that is to be applied to the text.
\value FontLetterSpacing Changes the default spacing between individual letters in the font. The value is
specified in percentage, with 100 as the default value.
\value FontWordSpacing Changes the default spacing between individual words. A positive value increases the word spacing
by the corresponding pixels; a negative value decreases the spacing.
\value FontStyleHint Corresponds to the QFont::StyleHint property
\value FontStyleStrategy Corresponds to the QFont::StyleStrategy property
\value FontKerning Specifies whether the font has kerning turned on.
\omitvalue FirstFontProperty
\omitvalue LastFontProperty
\value TextUnderlineColor
\value TextVerticalAlignment
\value TextOutline
\value TextUnderlineStyle
\value TextToolTip Specifies the (optional) tool tip to be displayed for a fragment of text.
\value IsAnchor
\value AnchorHref
\value AnchorName
\value ObjectType
List properties
\value ListStyle
\value ListIndent
Table and frame properties
\value FrameBorder
\value FrameBorderBrush
\value FrameBorderStyle
\value FrameBottomMargin
\value FrameHeight
\value FrameLeftMargin
\value FrameMargin
\value FramePadding
\value FrameRightMargin
\value FrameTopMargin
\value FrameWidth
\value TableCellSpacing
\value TableCellPadding
\value TableColumns
\value TableColumnWidthConstraints
\value TableHeaderRowCount
Table cell properties
\value TableCellRowSpan
\value TableCellColumnSpan
\value TableCellLeftPadding
\value TableCellRightPadding
\value TableCellTopPadding
\value TableCellBottomPadding
Image properties
\value ImageName
\value ImageWidth
\value ImageHeight
Selection properties
\value FullWidthSelection When set on the characterFormat of a selection, the whole width of the text will be shown selected
Page break properties
\value PageBreakPolicy
\value UserProperty
*/
/*!
\enum QTextFormat::ObjectTypes
\value NoObject
\value ImageObject
\value TableObject
\value TableCellObject
\value UserObject The first object that can be used for application-specific purposes.
*/
/*!
\enum QTextFormat::PageBreakFlag
\since 4.2
\value PageBreak_Auto The page break is determined automatically depending on the
available space on the current page
\value PageBreak_AlwaysBefore The page is always broken before the paragraph/table
\value PageBreak_AlwaysAfter A new page is always started after the paragraph/table
*/
/*!
\fn bool QTextFormat::isValid() const
Returns true if the format is valid (i.e. is not
InvalidFormat); otherwise returns false.
*/
/*!
\fn bool QTextFormat::isCharFormat() const
Returns true if this text format is a \c CharFormat; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isBlockFormat() const
Returns true if this text format is a \c BlockFormat; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isListFormat() const
Returns true if this text format is a \c ListFormat; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isTableFormat() const
Returns true if this text format is a \c TableFormat; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isFrameFormat() const
Returns true if this text format is a \c FrameFormat; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isImageFormat() const
Returns true if this text format is an image format; otherwise
returns false.
*/
/*!
\fn bool QTextFormat::isTableCellFormat() const
\since 4.4
Returns true if this text format is a \c TableCellFormat; otherwise
returns false.
*/
/*!
Creates a new text format with an \c InvalidFormat.
\sa FormatType
*/
QTextFormat::QTextFormat()
: format_type(InvalidFormat)
{
}
/*!
Creates a new text format of the given \a type.
\sa FormatType
*/
QTextFormat::QTextFormat(int type)
: format_type(type)
{
}
/*!
\fn QTextFormat::QTextFormat(const QTextFormat &other)
Creates a new text format with the same attributes as the \a other
text format.
*/
QTextFormat::QTextFormat(const QTextFormat &rhs)
: d(rhs.d), format_type(rhs.format_type)
{
}
/*!
\fn QTextFormat &QTextFormat::operator=(const QTextFormat &other)
Assigns the \a other text format to this text format, and returns a
reference to this text format.
*/
QTextFormat &QTextFormat::operator=(const QTextFormat &rhs)
{
d = rhs.d;
format_type = rhs.format_type;
return *this;
}
/*!
Destroys this text format.
*/
QTextFormat::~QTextFormat()
{
}
/*!
Returns the text format as a QVariant
*/
QTextFormat::operator QVariant() const
{
return QVariant(QVariant::TextFormat, this);
}
/*!
Merges the \a other format with this format; where there are
conflicts the \a other format takes precedence.
*/
void QTextFormat::merge(const QTextFormat &other)
{
if (format_type != other.format_type)
return;
if (!d) {
d = other.d;
return;
}
if (!other.d)
return;
QTextFormatPrivate *d = this->d;
const QVector<QTextFormatPrivate::Property> &otherProps = other.d->props;
d->props.reserve(d->props.size() + otherProps.size());
for (int i = 0; i < otherProps.count(); ++i) {
const QTextFormatPrivate::Property &p = otherProps.at(i);
d->insertProperty(p.key, p.value);
}
}
/*!
Returns the type of this format.
\sa FormatType
*/
int QTextFormat::type() const
{
return format_type;
}
/*!
Returns this format as a block format.
*/
QTextBlockFormat QTextFormat::toBlockFormat() const
{
return QTextBlockFormat(*this);
}
/*!
Returns this format as a character format.
*/
QTextCharFormat QTextFormat::toCharFormat() const
{
return QTextCharFormat(*this);
}
/*!
Returns this format as a list format.
*/
QTextListFormat QTextFormat::toListFormat() const
{
return QTextListFormat(*this);
}
/*!
Returns this format as a table format.
*/
QTextTableFormat QTextFormat::toTableFormat() const
{
return QTextTableFormat(*this);
}
/*!
Returns this format as a frame format.
*/
QTextFrameFormat QTextFormat::toFrameFormat() const
{
return QTextFrameFormat(*this);
}
/*!
Returns this format as an image format.
*/
QTextImageFormat QTextFormat::toImageFormat() const
{
return QTextImageFormat(*this);
}
/*!
\since 4.4
Returns this format as a table cell format.
*/
QTextTableCellFormat QTextFormat::toTableCellFormat() const
{
return QTextTableCellFormat(*this);
}
/*!
Returns the value of the property specified by \a propertyId. If the
property isn't of QTextFormat::Bool type, false is returned instead.
\sa setProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
*/
bool QTextFormat::boolProperty(int propertyId) const
{
if (!d)
return false;
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Bool)
return false;
return prop.toBool();
}
/*!
Returns the value of the property specified by \a propertyId. If the
property is not of QTextFormat::Integer type, 0 is returned instead.
\sa setProperty() boolProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
*/
int QTextFormat::intProperty(int propertyId) const
{
if (!d)
return 0;
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Int)
return 0;
return prop.toInt();
}
/*!
Returns the value of the property specified by \a propertyId. If the
property isn't of QVariant::Double or QMetaType::Float type, 0 is
returned instead.
\sa setProperty() boolProperty() intProperty() stringProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
*/
qreal QTextFormat::doubleProperty(int propertyId) const
{
if (!d)
return 0.;
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Double && prop.type() != QMetaType::Float)
return 0.;
return qVariantValue<qreal>(prop);
}
/*!
Returns the value of the property given by \a propertyId; if the
property isn't of QVariant::String type, an empty string is
returned instead.
\sa setProperty() boolProperty() intProperty() doubleProperty() colorProperty() lengthProperty() lengthVectorProperty() Property
*/
QString QTextFormat::stringProperty(int propertyId) const
{
if (!d)
return QString();
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::String)
return QString();
return prop.toString();
}
/*!
Returns the value of the property given by \a propertyId; if the
property isn't of QVariant::Color type, an invalid color is
returned instead.
\sa setProperty(), boolProperty(), intProperty(), doubleProperty(),
stringProperty(), lengthProperty(), lengthVectorProperty(), Property
*/
QColor QTextFormat::colorProperty(int propertyId) const
{
if (!d)
return QColor();
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Color)
return QColor();
return qvariant_cast<QColor>(prop);
}
/*!
Returns the value of the property given by \a propertyId; if the
property isn't of QVariant::Pen type, Qt::NoPen is
returned instead.
\sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
*/
QPen QTextFormat::penProperty(int propertyId) const
{
if (!d)
return QPen(Qt::NoPen);
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Pen)
return QPen(Qt::NoPen);
return qvariant_cast<QPen>(prop);
}
/*!
Returns the value of the property given by \a propertyId; if the
property isn't of QVariant::Brush type, Qt::NoBrush is
returned instead.
\sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() lengthProperty() lengthVectorProperty() Property
*/
QBrush QTextFormat::brushProperty(int propertyId) const
{
if (!d)
return QBrush(Qt::NoBrush);
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::Brush)
return QBrush(Qt::NoBrush);
return qvariant_cast<QBrush>(prop);
}
/*!
Returns the value of the property given by \a propertyId.
\sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthVectorProperty() Property
*/
QTextLength QTextFormat::lengthProperty(int propertyId) const
{
if (!d)
return QTextLength();
return qvariant_cast<QTextLength>(d->property(propertyId));
}
/*!
Returns the value of the property given by \a propertyId. If the
property isn't of QTextFormat::LengthVector type, an empty length
vector is returned instead.
\sa setProperty() boolProperty() intProperty() doubleProperty() stringProperty() colorProperty() lengthProperty() Property
*/
QVector<QTextLength> QTextFormat::lengthVectorProperty(int propertyId) const
{
QVector<QTextLength> vector;
if (!d)
return vector;
const QVariant prop = d->property(propertyId);
if (prop.type() != QVariant::List)
return vector;
QList<QVariant> propertyList = prop.toList();
for (int i=0; i<propertyList.size(); ++i) {
QVariant var = propertyList.at(i);
if (var.type() == QVariant::TextLength)
vector.append(qvariant_cast<QTextLength>(var));
}
return vector;
}
/*!
Returns the property specified by the given \a propertyId.
*/
QVariant QTextFormat::property(int propertyId) const
{
return d ? d->property(propertyId) : QVariant();
}
/*!
Sets the property specified by the \a propertyId to the given \a value.
*/
void QTextFormat::setProperty(int propertyId, const QVariant &value)
{
if (!d)
d = new QTextFormatPrivate;
if (!value.isValid())
clearProperty(propertyId);
else
d->insertProperty(propertyId, value);
}
/*!
Sets the value of the property given by \a propertyId to \a value.
\sa lengthVectorProperty() Property
*/
void QTextFormat::setProperty(int propertyId, const QVector<QTextLength> &value)
{
if (!d)
d = new QTextFormatPrivate;
QVariantList list;
for (int i=0; i<value.size(); ++i)
list << value.at(i);
d->insertProperty(propertyId, list);
}
/*!
Clears the value of the property given by \a propertyId
*/
void QTextFormat::clearProperty(int propertyId)
{
if (!d)
return;
d->clearProperty(propertyId);
}
/*!
\fn void QTextFormat::setObjectType(int type)
Sets the text format's object \a type. See \c{ObjectTypes}.
*/
/*!
\fn int QTextFormat::objectType() const
Returns the text format's object type. See \c{ObjectTypes}.
*/
/*!
Returns the index of the format object, or -1 if the format object is invalid.
\sa setObjectIndex()
*/
int QTextFormat::objectIndex() const
{
if (!d)
return -1;
const QVariant prop = d->property(ObjectIndex);
if (prop.type() != QVariant::Int) // ####
return -1;
return prop.toInt();
}
/*!
\fn void QTextFormat::setObjectIndex(int index)
Sets the format object's object \a index.
\sa objectIndex()
*/
void QTextFormat::setObjectIndex(int o)
{
if (o == -1) {
if (d)
d->clearProperty(ObjectIndex);
} else {
if (!d)
d = new QTextFormatPrivate;
// ### type
d->insertProperty(ObjectIndex, o);
}
}
/*!
Returns true if the text format has a property with the given \a
propertyId; otherwise returns false.
\sa properties() Property
*/
bool QTextFormat::hasProperty(int propertyId) const
{
return d ? d->hasProperty(propertyId) : false;
}
/*
Returns the property type for the given \a propertyId.
\sa hasProperty() allPropertyIds() Property
*/
/*!
Returns a map with all properties of this text format.
*/
QMap<int, QVariant> QTextFormat::properties() const
{
QMap<int, QVariant> map;
if (d) {
for (int i = 0; i < d->props.count(); ++i)
map.insert(d->props.at(i).key, d->props.at(i).value);
}
return map;
}
/*!
\since 4.3
Returns the number of properties stored in the format.
*/
int QTextFormat::propertyCount() const
{
return d ? d->props.count() : 0;
}
/*!
\fn bool QTextFormat::operator!=(const QTextFormat &other) const
Returns true if this text format is different from the \a other text
format.
*/
/*!
\fn bool QTextFormat::operator==(const QTextFormat &other) const
Returns true if this text format is the same as the \a other text
format.
*/
bool QTextFormat::operator==(const QTextFormat &rhs) const
{
if (format_type != rhs.format_type)
return false;
if (d == rhs.d)
return true;
if (d && d->props.isEmpty() && !rhs.d)
return true;
if (!d && rhs.d && rhs.d->props.isEmpty())
return true;
if (!d || !rhs.d)
return false;
return *d == *rhs.d;
}
/*!
\class QTextCharFormat
\reentrant
\brief The QTextCharFormat class provides formatting information for
characters in a QTextDocument.
\ingroup text
The character format of text in a document specifies the visual properties
of the text, as well as information about its role in a hypertext document.
The font used can be set by supplying a font to the setFont() function, and
each aspect of its appearance can be adjusted to give the desired effect.
setFontFamily() and setFontPointSize() define the font's family (e.g. Times)
and printed size; setFontWeight() and setFontItalic() provide control over
the style of the font. setFontUnderline(), setFontOverline(),
setFontStrikeOut(), and setFontFixedPitch() provide additional effects for
text.
The color is set with setForeground(). If the text is intended to be used
as an anchor (for hyperlinks), this can be enabled with setAnchor(). The
setAnchorHref() and setAnchorNames() functions are used to specify the
information about the hyperlink's destination and the anchor's name.
\sa QTextFormat QTextBlockFormat QTextTableFormat QTextListFormat
*/
/*!
\enum QTextCharFormat::VerticalAlignment
This enum describes the ways that adjacent characters can be vertically
aligned.
\value AlignNormal Adjacent characters are positioned in the standard
way for text in the writing system in use.
\value AlignSuperScript Characters are placed above the baseline for
normal text.
\value AlignSubScript Characters are placed below the baseline for
normal text.
\value AlignMiddle The center of the object is vertically aligned with the base line.
Currently, this is only implemented for inline objects.
\value AlignBottom The bottom edge of the object is vertically aligned with
the base line.
\value AlignTop The top edge of the object is vertically aligned with
the base line.
*/
/*!
\enum QTextCharFormat::UnderlineStyle
This enum describes the different ways drawing underlined text.
\value NoUnderline Text is draw without any underlining decoration.
\value SingleUnderline A line is drawn using Qt::SolidLine.
\value DashUnderline Dashes are drawn using Qt::DashLine.
\value DotLine Dots are drawn using Qt::DotLine;
\value DashDotLine Dashs and dots are drawn using Qt::DashDotLine.
\value DashDotDotLine Underlines draw drawn using Qt::DashDotDotLine.
\value WaveUnderline The text is underlined using a wave shaped line.
\value SpellCheckUnderline The underline is drawn depending on the QStyle::SH_SpellCeckUnderlineStyle
style hint of the QApplication style. By default this is mapped to
WaveUnderline, on Mac OS X it is mapped to DashDotLine.
\sa Qt::PenStyle
*/
/*!
\fn QTextCharFormat::QTextCharFormat()
Constructs a new character format object.
*/
QTextCharFormat::QTextCharFormat() : QTextFormat(CharFormat) {}
/*!
\internal
\fn QTextCharFormat::QTextCharFormat(const QTextFormat &other)
Creates a new character format with the same attributes as the \a given
text format.
*/
QTextCharFormat::QTextCharFormat(const QTextFormat &fmt)
: QTextFormat(fmt)
{
}
/*!
\fn bool QTextCharFormat::isValid() const
Returns true if this character format is valid; otherwise returns
false.
*/
/*!
\fn void QTextCharFormat::setFontFamily(const QString &family)
Sets the text format's font \a family.
\sa setFont()
*/
/*!
\fn QString QTextCharFormat::fontFamily() const
Returns the text format's font family.
\sa font()
*/
/*!
\fn void QTextCharFormat::setFontPointSize(qreal size)
Sets the text format's font \a size.
\sa setFont()
*/
/*!
\fn qreal QTextCharFormat::fontPointSize() const
Returns the font size used to display text in this format.
\sa font()
*/
/*!
\fn void QTextCharFormat::setFontWeight(int weight)
Sets the text format's font weight to \a weight.
\sa setFont(), QFont::Weight
*/
/*!
\fn int QTextCharFormat::fontWeight() const
Returns the text format's font weight.
\sa font(), QFont::Weight
*/
/*!
\fn void QTextCharFormat::setFontItalic(bool italic)
If \a italic is true, sets the text format's font to be italic; otherwise
the font will be non-italic.
\sa setFont()
*/
/*!
\fn bool QTextCharFormat::fontItalic() const
Returns true if the text format's font is italic; otherwise
returns false.
\sa font()
*/
/*!
\fn void QTextCharFormat::setFontUnderline(bool underline)
If \a underline is true, sets the text format's font to be underlined;
otherwise it is displayed non-underlined.
\sa setFont()
*/
/*!
\fn bool QTextCharFormat::fontUnderline() const
Returns true if the text format's font is underlined; otherwise
returns false.
\sa font()
*/
bool QTextCharFormat::fontUnderline() const
{
if (hasProperty(TextUnderlineStyle))
return underlineStyle() == SingleUnderline;
return boolProperty(FontUnderline);
}
/*!
\fn UnderlineStyle QTextCharFormat::underlineStyle() const
\since 4.2
Returns the style of underlining the text.
*/
/*!
\fn void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
\since 4.2
Sets the style of underlining the text to \a style.
*/
void QTextCharFormat::setUnderlineStyle(UnderlineStyle style)
{
setProperty(TextUnderlineStyle, style);
// for compatibility
setProperty(FontUnderline, style == SingleUnderline);
}
/*!
\fn void QTextCharFormat::setFontOverline(bool overline)
If \a overline is true, sets the text format's font to be overlined;
otherwise the font is displayed non-overlined.
\sa setFont()
*/
/*!
\fn bool QTextCharFormat::fontOverline() const
Returns true if the text format's font is overlined; otherwise
returns false.
\sa font()
*/
/*!
\fn void QTextCharFormat::setFontStrikeOut(bool strikeOut)
If \a strikeOut is true, sets the text format's font with strike-out
enabled (with a horizontal line through it); otherwise it is displayed
without strikeout.
\sa setFont()
*/
/*!
\fn bool QTextCharFormat::fontStrikeOut() const
Returns true if the text format's font is struck out (has a horizontal line
drawn through it); otherwise returns false.
\sa font()
*/
/*!
\since 4.5
\fn void QTextCharFormat::setFontStyleHint(QFont::StyleHint hint, QFont::StyleStrategy strategy)
Sets the font style \a hint and \a strategy.
Qt does not support style hints on X11 since this information is not provided by the window system.
\sa setFont()
\sa QFont::setStyleHint()
*/
/*!
\since 4.5
\fn void QTextCharFormat::setFontStyleStrategy(QFont::StyleStrategy strategy)
Sets the font style \a strategy.
\sa setFont()
\sa QFont::setStyleStrategy()
*/
/*!
\since 4.5
\fn void QTextCharFormat::setFontKerning(bool enable)
Enables kerning for this font if \a enable is true; otherwise disables it.
When kerning is enabled, glyph metrics do not add up anymore, even for
Latin text. In other words, the assumption that width('a') + width('b')
is equal to width("ab") is not neccesairly true.
\sa setFont()
*/
/*!
\fn QTextCharFormat::StyleHint QTextCharFormat::fontStyleHint() const
\since 4.5
Returns the font style hint.
\sa setFontStyleHint(), font()
*/
/*!
\since 4.5
\fn QTextCharFormat::StyleStrategy QTextCharFormat::fontStyleStrategy() const
Returns the current font style strategy.
\sa setFontStyleStrategy()
\sa font()
*/
/*!
\since 4.5
\fn bool QTextCharFormat::fontKerning() const
Returns true if the font kerning is enabled.
\sa setFontKerning()
\sa font()
*/
/*!
\fn void QTextCharFormat::setFontFixedPitch(bool fixedPitch)
If \a fixedPitch is true, sets the text format's font to be fixed pitch;
otherwise a non-fixed pitch font is used.
\sa setFont()
*/
/*!
\fn bool QTextCharFormat::fontFixedPitch() const
Returns true if the text format's font is fixed pitch; otherwise
returns false.
\sa font()
*/
/*!
\fn QPen QTextCharFormat::textOutline() const
Returns the pen used to draw the outlines of characters in this format.
*/
/*!
\fn void QTextCharFormat::setTextOutline(const QPen &pen)
Sets the pen used to draw the outlines of characters to the given \a pen.
*/
/*!
\fn void QTextCharFormat::setToolTip(const QString &text)
\since 4.3
Sets the tool tip for a fragment of text to the given \a text.
*/
/*!
\fn QString QTextCharFormat::toolTip() const
\since 4.3
Returns the tool tip that is displayed for a fragment of text.
*/
/*!
\fn void QTextFormat::setForeground(const QBrush &brush)
Sets the foreground brush to the specified \a brush. The foreground
brush is mostly used to render text.
\sa foreground() clearForeground() setBackground()
*/
/*!
\fn QBrush QTextFormat::foreground() const
Returns the brush used to render foreground details, such as text,
frame outlines, and table borders.
\sa setForeground() clearForeground() background()
*/
/*!
\fn void QTextFormat::clearForeground()
Clears the brush used to paint the document's foreground. The default
brush will be used.
\sa foreground() setForeground() clearBackground()
*/
/*!
\fn void QTextCharFormat::setAnchor(bool anchor)
If \a anchor is true, text with this format represents an anchor, and is
formatted in the appropriate way; otherwise the text is formatted normally.
(Anchors are hyperlinks which are often shown underlined and in a different
color from plain text.)
The way the text is rendered is independent of whether or not the format
has a valid anchor defined. Use setAnchorHref(), and optionally
setAnchorNames() to create a hypertext link.
\sa isAnchor()
*/
/*!
\fn bool QTextCharFormat::isAnchor() const
Returns true if the text is formatted as an anchor; otherwise
returns false.
\sa setAnchor() setAnchorHref() setAnchorNames()
*/
/*!
\fn void QTextCharFormat::setAnchorHref(const QString &value)
Sets the hypertext link for the text format to the given \a value.
This is typically a URL like "http://example.com/index.html".
The anchor will be displayed with the \a value as its display text;
if you want to display different text call setAnchorNames().
To format the text as a hypertext link use setAnchor().
*/
/*!
\fn QString QTextCharFormat::anchorHref() const
Returns the text format's hypertext link, or an empty string if
none has been set.
*/
/*!
\fn void QTextCharFormat::setAnchorName(const QString &name)
\obsolete
This function is deprecated. Use setAnchorNames() instead.
Sets the text format's anchor \a name. For the anchor to work as a
hyperlink, the destination must be set with setAnchorHref() and
the anchor must be enabled with setAnchor().
*/
/*!
\fn void QTextCharFormat::setAnchorNames(const QStringList &names)
\since 4.3
Sets the text format's anchor \a names. For the anchor to work as a
hyperlink, the destination must be set with setAnchorHref() and
the anchor must be enabled with setAnchor().
*/
/*!
\fn QString QTextCharFormat::anchorName() const
\obsolete
This function is deprecated. Use anchorNames() instead.
Returns the anchor name associated with this text format, or an empty
string if none has been set. If the anchor name is set, text with this
format can be the destination of a hypertext link.
*/
QString QTextCharFormat::anchorName() const
{
QVariant prop = property(AnchorName);
if (prop.type() == QVariant::StringList)
return prop.toStringList().value(0);
else if (prop.type() != QVariant::String)
return QString();
return prop.toString();
}
/*!
\fn QStringList QTextCharFormat::anchorNames() const
\since 4.3
Returns the anchor names associated with this text format, or an empty
string list if none has been set. If the anchor names are set, text with this
format can be the destination of a hypertext link.
*/
QStringList QTextCharFormat::anchorNames() const
{
QVariant prop = property(AnchorName);
if (prop.type() == QVariant::StringList)
return prop.toStringList();
else if (prop.type() != QVariant::String)
return QStringList();
return QStringList(prop.toString());
}
/*!
\fn void QTextCharFormat::setTableCellRowSpan(int tableCellRowSpan)
\internal
If this character format is applied to characters in a table cell,
the cell will span \a tableCellRowSpan rows.
*/
/*!
\fn int QTextCharFormat::tableCellRowSpan() const
\internal
If this character format is applied to characters in a table cell,
this function returns the number of rows spanned by the text (this may
be 1); otherwise it returns 1.
*/
/*!
\fn void QTextCharFormat::setTableCellColumnSpan(int tableCellColumnSpan)
\internal
If this character format is applied to characters in a table cell,
the cell will span \a tableCellColumnSpan columns.
*/
/*!
\fn int QTextCharFormat::tableCellColumnSpan() const
\internal
If this character format is applied to characters in a table cell,
this function returns the number of columns spanned by the text (this
may be 1); otherwise it returns 1.
*/
/*!
\fn void QTextCharFormat::setUnderlineColor(const QColor &color)
Sets the underline color used for the characters with this format to
the \a color specified.
\sa underlineColor()
*/
/*!
\fn QColor QTextCharFormat::underlineColor() const
Returns the color used to underline the characters with this format.
\sa setUnderlineColor()
*/
/*!
\fn void QTextCharFormat::setVerticalAlignment(VerticalAlignment alignment)
Sets the vertical alignment used for the characters with this format to
the \a alignment specified.
\sa verticalAlignment()
*/
/*!
\fn VerticalAlignment QTextCharFormat::verticalAlignment() const
Returns the vertical alignment used for characters with this format.
\sa setVerticalAlignment()
*/
/*!
Sets the text format's \a font.
*/
void QTextCharFormat::setFont(const QFont &font)
{
setFontFamily(font.family());
const qreal pointSize = font.pointSizeF();
if (pointSize > 0) {
setFontPointSize(pointSize);
} else {
const int pixelSize = font.pixelSize();
if (pixelSize > 0)
setProperty(QTextFormat::FontPixelSize, pixelSize);
}
setFontWeight(font.weight());
setFontItalic(font.italic());
setUnderlineStyle(font.underline() ? SingleUnderline : NoUnderline);
setFontOverline(font.overline());
setFontStrikeOut(font.strikeOut());
setFontFixedPitch(font.fixedPitch());
setFontCapitalization(font.capitalization());
setFontWordSpacing(font.wordSpacing());
if (font.letterSpacingType() == QFont::PercentageSpacing)
setFontLetterSpacing(font.letterSpacing());
setFontStyleHint(font.styleHint());
setFontStyleStrategy(font.styleStrategy());
setFontKerning(font.kerning());
}
/*!
Returns the font for this character format.
*/
QFont QTextCharFormat::font() const
{
return d ? d->font() : QFont();
}
/*!
\class QTextBlockFormat
\reentrant
\brief The QTextBlockFormat class provides formatting information for
blocks of text in a QTextDocument.
\ingroup text
A document is composed of a list of blocks, represented by QTextBlock
objects. Each block can contain an item of some kind, such as a
paragraph of text, a table, a list, or an image. Every block has an
associated QTextBlockFormat that specifies its characteristics.
To cater for left-to-right and right-to-left languages you can set
a block's direction with setDirection(). Paragraph alignment is
set with setAlignment(). Margins are controlled by setTopMargin(),
setBottomMargin(), setLeftMargin(), setRightMargin(). Overall
indentation is set with setIndent(), the indentation of the first
line with setTextIndent().
Line breaking can be enabled and disabled with setNonBreakableLines().
The brush used to paint the paragraph's background
is set with \l{QTextFormat::setBackground()}{setBackground()}, and other
aspects of the text's appearance can be customized by using the
\l{QTextFormat::setProperty()}{setProperty()} function with the
\c OutlinePen, \c ForegroundBrush, and \c BackgroundBrush
\l{QTextFormat::Property} values.
If a text block is part of a list, it can also have a list format that
is accessible with the listFormat() function.
\sa QTextBlock, QTextCharFormat
*/
/*!
\fn QTextBlockFormat::QTextBlockFormat()
Constructs a new QTextBlockFormat.
*/
QTextBlockFormat::QTextBlockFormat() : QTextFormat(BlockFormat) {}
/*!
\internal
\fn QTextBlockFormat::QTextBlockFormat(const QTextFormat &other)
Creates a new block format with the same attributes as the \a given
text format.
*/
QTextBlockFormat::QTextBlockFormat(const QTextFormat &fmt)
: QTextFormat(fmt)
{
}
/*!
\since 4.4
Sets the tab positions for the text block to those specified by
\a tabs.
\sa tabPositions()
*/
void QTextBlockFormat::setTabPositions(const QList<QTextOption::Tab> &tabs)
{
QList<QVariant> list;
QList<QTextOption::Tab>::ConstIterator iter = tabs.constBegin();
while (iter != tabs.constEnd()) {
QVariant v;
qVariantSetValue<QTextOption::Tab>(v, *iter);
list.append(v);
++iter;
}
setProperty(TabPositions, list);
}
/*!
\since 4.4
Returns a list of tab positions defined for the text block.
\sa setTabPositions()
*/
QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
{
QVariant variant = property(TabPositions);
if(variant.isNull())
return QList<QTextOption::Tab>();
QList<QTextOption::Tab> answer;
QList<QVariant> variantsList = qvariant_cast<QList<QVariant> >(variant);
QList<QVariant>::Iterator iter = variantsList.begin();
while(iter != variantsList.end()) {
answer.append( qVariantValue<QTextOption::Tab>(*iter));
++iter;
}
return answer;
}
/*!
\fn QTextBlockFormat::isValid() const
Returns true if this block format is valid; otherwise returns
false.
*/
/*!
\fn void QTextFormat::setLayoutDirection(Qt::LayoutDirection direction)
Sets the document's layout direction to the specified \a direction.
\sa layoutDirection()
*/
/*!
\fn Qt::LayoutDirection QTextFormat::layoutDirection() const
Returns the document's layout direction.
\sa setLayoutDirection()
*/
/*!
\fn void QTextBlockFormat::setAlignment(Qt::Alignment alignment)
Sets the paragraph's \a alignment.
\sa alignment()
*/
/*!
\fn Qt::Alignment QTextBlockFormat::alignment() const
Returns the paragraph's alignment.
\sa setAlignment()
*/
/*!
\fn void QTextBlockFormat::setTopMargin(qreal margin)
Sets the paragraph's top \a margin.
\sa topMargin() setBottomMargin() setLeftMargin() setRightMargin()
*/
/*!
\fn qreal QTextBlockFormat::topMargin() const
Returns the paragraph's top margin.
\sa setTopMargin() bottomMargin()
*/
/*!
\fn void QTextBlockFormat::setBottomMargin(qreal margin)
Sets the paragraph's bottom \a margin.
\sa bottomMargin() setTopMargin() setLeftMargin() setRightMargin()
*/
/*!
\fn qreal QTextBlockFormat::bottomMargin() const
Returns the paragraph's bottom margin.
\sa setBottomMargin() topMargin()
*/
/*!
\fn void QTextBlockFormat::setLeftMargin(qreal margin)
Sets the paragraph's left \a margin. Indentation can be applied separately
with setIndent().
\sa leftMargin() setRightMargin() setTopMargin() setBottomMargin()
*/
/*!
\fn qreal QTextBlockFormat::leftMargin() const
Returns the paragraph's left margin.
\sa setLeftMargin() rightMargin() indent()
*/
/*!
\fn void QTextBlockFormat::setRightMargin(qreal margin)
Sets the paragraph's right \a margin.
\sa rightMargin() setLeftMargin() setTopMargin() setBottomMargin()
*/
/*!
\fn qreal QTextBlockFormat::rightMargin() const
Returns the paragraph's right margin.
\sa setRightMargin() leftMargin()
*/
/*!
\fn void QTextBlockFormat::setTextIndent(qreal indent)
Sets the \a indent for the first line in the block. This allows the first
line of a paragraph to be indented differently to the other lines,
enhancing the readability of the text.
\sa textIndent() setLeftMargin() setRightMargin() setTopMargin() setBottomMargin()
*/
/*!
\fn qreal QTextBlockFormat::textIndent() const
Returns the paragraph's text indent.
\sa setTextIndent()
*/
/*!
\fn void QTextBlockFormat::setIndent(int indentation)
Sets the paragraph's \a indentation. Margins are set independently of
indentation with setLeftMargin() and setTextIndent().
The \a indentation is an integer that is multiplied with the document-wide
standard indent, resulting in the actual indent of the paragraph.
\sa indent() QTextDocument::indentWidth()
*/
/*!
\fn int QTextBlockFormat::indent() const
Returns the paragraph's indent.
\sa setIndent()
*/
/*!
\fn void QTextBlockFormat::setNonBreakableLines(bool b)
If \a b is true, the lines in the paragraph are treated as
non-breakable; otherwise they are breakable.
\sa nonBreakableLines()
*/
/*!
\fn bool QTextBlockFormat::nonBreakableLines() const
Returns true if the lines in the paragraph are non-breakable;
otherwise returns false.
\sa setNonBreakableLines()
*/
/*!
\fn QTextFormat::PageBreakFlags QTextBlockFormat::pageBreakPolicy() const
\since 4.2
Returns the currently set page break policy for the paragraph. The default is
QTextFormat::PageBreak_Auto.
\sa setPageBreakPolicy()
*/
/*!
\fn void QTextBlockFormat::setPageBreakPolicy(PageBreakFlags policy)
\since 4.2
Sets the page break policy for the paragraph to \a policy.
\sa pageBreakPolicy()
*/
/*!
\class QTextListFormat
\reentrant
\brief The QTextListFormat class provides formatting information for
lists in a QTextDocument.
\ingroup text
A list is composed of one or more items, represented as text blocks.
The list's format specifies the appearance of items in the list.
In particular, it determines the indentation and the style of each item.
The indentation of the items is an integer value that causes each item to
be offset from the left margin by a certain amount. This value is read with
indent() and set with setIndent().
The style used to decorate each item is set with setStyle() and can be read
with the style() function. The style controls the type of bullet points and
numbering scheme used for items in the list. Note that lists that use the
decimal numbering scheme begin counting at 1 rather than 0.
\sa QTextList
*/
/*!
\enum QTextListFormat::Style
This enum describes the symbols used to decorate list items:
\value ListDisc a filled circle
\value ListCircle an empty circle
\value ListSquare a filled square
\value ListDecimal decimal values in ascending order
\value ListLowerAlpha lower case Latin characters in alphabetical order
\value ListUpperAlpha upper case Latin characters in alphabetical order
\omitvalue ListStyleUndefined
*/
/*!
\fn QTextListFormat::QTextListFormat()
Constructs a new list format object.
*/
QTextListFormat::QTextListFormat()
: QTextFormat(ListFormat)
{
setIndent(1);
}
/*!
\internal
\fn QTextListFormat::QTextListFormat(const QTextFormat &other)
Creates a new list format with the same attributes as the \a given
text format.
*/
QTextListFormat::QTextListFormat(const QTextFormat &fmt)
: QTextFormat(fmt)
{
}
/*!
\fn bool QTextListFormat::isValid() const
Returns true if this list format is valid; otherwise
returns false.
*/
/*!
\fn void QTextListFormat::setStyle(Style style)
Sets the list format's \a style. See \c{Style} for the available styles.
\sa style()
*/
/*!
\fn Style QTextListFormat::style() const
Returns the list format's style. See \c{Style}.
\sa setStyle()
*/
/*!
\fn void QTextListFormat::setIndent(int indentation)
Sets the list format's \a indentation.
The indentation is multiplied by the QTextDocument::indentWidth
property to get the effective indent in pixels.
\sa indent()
*/
/*!
\fn int QTextListFormat::indent() const
Returns the list format's indentation.
The indentation is multiplied by the QTextDocument::indentWidth
property to get the effective indent in pixels.
\sa setIndent()
*/
/*!
\class QTextFrameFormat
\reentrant
\brief The QTextFrameFormat class provides formatting information for
frames in a QTextDocument.
\ingroup text
A text frame groups together one or more blocks of text, providing a layer
of structure larger than the paragraph. The format of a frame specifies
how it is rendered and positioned on the screen. It does not directly
specify the behavior of the text formatting within, but provides
constraints on the layout of its children.
The frame format defines the width() and height() of the frame on the
screen. Each frame can have a border() that surrounds its contents with
a rectangular box. The border is surrounded by a margin() around the frame,
and the contents of the frame are kept separate from the border by the
frame's padding(). This scheme is similar to the box model used by Cascading
Style Sheets for HTML pages.
\img qtextframe-style.png
The position() of a frame is set using setPosition() and determines how it
is located relative to the surrounding text.
The validity of a QTextFrameFormat object can be determined with the
isValid() function.
\sa QTextFrame QTextBlockFormat
*/
/*!
\enum QTextFrameFormat::Position
\value InFlow
\value FloatLeft
\value FloatRight
*/
/*!
\enum QTextFrameFormat::BorderStyle
\since 4.3
\value BorderStyle_None
\value BorderStyle_Dotted
\value BorderStyle_Dashed
\value BorderStyle_Solid
\value BorderStyle_Double
\value BorderStyle_DotDash
\value BorderStyle_DotDotDash
\value BorderStyle_Groove
\value BorderStyle_Ridge
\value BorderStyle_Inset
\value BorderStyle_Outset
*/
/*!
\fn QTextFrameFormat::QTextFrameFormat()
Constructs a text frame format object with the default properties.
*/
QTextFrameFormat::QTextFrameFormat() : QTextFormat(FrameFormat)
{
setBorderStyle(BorderStyle_Outset);
setBorderBrush(Qt::darkGray);
}
/*!
\internal
\fn QTextFrameFormat::QTextFrameFormat(const QTextFormat &other)
Creates a new frame format with the same attributes as the \a given
text format.
*/
QTextFrameFormat::QTextFrameFormat(const QTextFormat &fmt)
: QTextFormat(fmt)
{
}
/*!
\fn QTextFrameFormat::isValid() const
Returns true if the format description is valid; otherwise returns false.
*/
/*!
\fn QTextFrameFormat::setPosition(Position policy)
Sets the \a policy for positioning frames with this frame format.
*/
/*!
\fn Position QTextFrameFormat::position() const
Returns the positioning policy for frames with this frame format.
*/
/*!
\fn QTextFrameFormat::setBorder(qreal width)
Sets the \a width (in pixels) of the frame's border.
*/
/*!
\fn qreal QTextFrameFormat::border() const
Returns the width of the border in pixels.
*/
/*!
\fn QTextFrameFormat::setBorderBrush(const QBrush &brush)
\since 4.3
Sets the \a brush used for the frame's border.
*/
/*!
\fn QBrush QTextFrameFormat::borderBrush() const
\since 4.3
Returns the brush used for the frame's border.
*/
/*!
\fn QTextFrameFormat::setBorderStyle(BorderStyle style)
\since 4.3
Sets the \a style of the frame's border.
*/
/*!
\fn BorderStyle QTextFrameFormat::borderStyle() const
\since 4.3
Returns the style of the frame's border.
*/
/*!
\fn QTextFrameFormat::setMargin(qreal margin)
Sets the frame's \a margin in pixels.
This method also sets the left, right, top and bottom margins
of the frame to the same value. The individual margins override
the general margin.
*/
void QTextFrameFormat::setMargin(qreal amargin)
{
setProperty(FrameMargin, amargin);
setProperty(FrameTopMargin, amargin);
setProperty(FrameBottomMargin, amargin);
setProperty(FrameLeftMargin, amargin);
setProperty(FrameRightMargin, amargin);
}
/*!
\fn qreal QTextFrameFormat::margin() const
Returns the width of the frame's external margin in pixels.
*/
/*!
\fn QTextFrameFormat::setTopMargin(qreal margin)
\since 4.3
Sets the frame's top \a margin in pixels.
*/
/*!
\fn qreal QTextFrameFormat::topMargin() const
\since 4.3
Returns the width of the frame's top margin in pixels.
*/
qreal QTextFrameFormat::topMargin() const
{
if (!hasProperty(FrameTopMargin))
return margin();
return doubleProperty(FrameTopMargin);
}
/*!
\fn QTextFrameFormat::setBottomMargin(qreal margin)
\since 4.3
Sets the frame's bottom \a margin in pixels.
*/
/*!
\fn qreal QTextFrameFormat::bottomMargin() const
\since 4.3
Returns the width of the frame's bottom margin in pixels.
*/
qreal QTextFrameFormat::bottomMargin() const
{
if (!hasProperty(FrameBottomMargin))
return margin();
return doubleProperty(FrameBottomMargin);
}
/*!
\fn QTextFrameFormat::setLeftMargin(qreal margin)
\since 4.3
Sets the frame's left \a margin in pixels.
*/
/*!
\fn qreal QTextFrameFormat::leftMargin() const
\since 4.3
Returns the width of the frame's left margin in pixels.
*/
qreal QTextFrameFormat::leftMargin() const
{
if (!hasProperty(FrameLeftMargin))
return margin();
return doubleProperty(FrameLeftMargin);
}
/*!
\fn QTextFrameFormat::setRightMargin(qreal margin)
\since 4.3
Sets the frame's right \a margin in pixels.
*/
/*!
\fn qreal QTextFrameFormat::rightMargin() const
\since 4.3
Returns the width of the frame's right margin in pixels.
*/
qreal QTextFrameFormat::rightMargin() const
{
if (!hasProperty(FrameRightMargin))
return margin();
return doubleProperty(FrameRightMargin);
}
/*!
\fn QTextFrameFormat::setPadding(qreal width)
Sets the \a width of the frame's internal padding in pixels.
*/
/*!
\fn qreal QTextFrameFormat::padding() const
Returns the width of the frame's internal padding in pixels.
*/
/*!
\fn QTextFrameFormat::setWidth(const QTextLength &width)
Sets the frame's border rectangle's \a width.
\sa QTextLength
*/
/*!
\fn QTextFrameFormat::setWidth(qreal width)
\overload
Convenience method that sets the width of the frame's border
rectangle's width to the specified fixed \a width.
*/
/*!
\fn QTextFormat::PageBreakFlags QTextFrameFormat::pageBreakPolicy() const
\since 4.2
Returns the currently set page break policy for the frame/table. The default is
QTextFormat::PageBreak_Auto.
\sa setPageBreakPolicy()
*/
/*!
\fn void QTextFrameFormat::setPageBreakPolicy(PageBreakFlags policy)
\since 4.2
Sets the page break policy for the frame/table to \a policy.
\sa pageBreakPolicy()
*/
/*!
\fn QTextLength QTextFrameFormat::width() const
Returns the width of the frame's border rectangle.
\sa QTextLength
*/
/*!
\fn void QTextFrameFormat::setHeight(const QTextLength &height)
Sets the frame's \a height.
*/
/*!
\fn void QTextFrameFormat::setHeight(qreal height)
\overload
Sets the frame's \a height.
*/
/*!
\fn qreal QTextFrameFormat::height() const
Returns the height of the frame's border rectangle.
*/
/*!
\class QTextTableFormat
\reentrant
\brief The QTextTableFormat class provides formatting information for
tables in a QTextDocument.
\ingroup text
A table is a group of cells ordered into rows and columns. Each table
contains at least one row and one column. Each cell contains a block.
Tables in rich text documents are formatted using the properties
defined in this class.
Tables are horizontally justified within their parent frame according to the
table's alignment. This can be read with the alignment() function and set
with setAlignment().
Cells within the table are separated by cell spacing. The number of pixels
between cells is set with setCellSpacing() and read with cellSpacing().
The contents of each cell is surrounded by cell padding. The number of pixels
between each cell edge and its contents is set with setCellPadding() and read
with cellPadding().
\image qtexttableformat-cell.png
The table's background color can be read with the background() function,
and can be specified with setBackground(). The background color of each
cell can be set independently, and will control the color of the cell within
the padded area.
The table format also provides a way to constrain the widths of the columns
in the table. Columns can be assigned a fixed width, a variable width, or
a percentage of the available width (see QTextLength). The columns() function
returns the number of columns with constraints, and the
columnWidthConstraints() function returns the constraints defined for the
table. These quantities can also be set by calling setColumnWidthConstraints()
with a vector containing new constraints. If no constraints are
required, clearColumnWidthConstraints() can be used to remove them.
\sa QTextTable QTextTableCell QTextLength
*/
/*!
\fn QTextTableFormat::QTextTableFormat()
Constructs a new table format object.
*/
QTextTableFormat::QTextTableFormat()
: QTextFrameFormat()
{
setObjectType(TableObject);
setCellSpacing(2);
setBorder(1);
}
/*!
\internal
\fn QTextTableFormat::QTextTableFormat(const QTextFormat &other)
Creates a new table format with the same attributes as the \a given
text format.
*/
QTextTableFormat::QTextTableFormat(const QTextFormat &fmt)
: QTextFrameFormat(fmt)
{
}
/*!
\fn bool QTextTableFormat::isValid() const
Returns true if this table format is valid; otherwise
returns false.
*/
/*!
\fn int QTextTableFormat::columns() const
Returns the number of columns specified by the table format.
*/
/*!
\internal
\fn void QTextTableFormat::setColumns(int columns)
Sets the number of \a columns required by the table format.
\sa columns()
*/
/*!
\fn void QTextTableFormat::clearColumnWidthConstraints()
Clears the column width constraints for the table.
\sa columnWidthConstraints() setColumnWidthConstraints()
*/
/*!
\fn void QTextTableFormat::setColumnWidthConstraints(const QVector<QTextLength> &constraints)
Sets the column width \a constraints for the table.
\sa columnWidthConstraints() clearColumnWidthConstraints()
*/
/*!
\fn QVector<QTextLength> QTextTableFormat::columnWidthConstraints() const
Returns a list of constraints used by this table format to control the
appearance of columns in a table.
\sa setColumnWidthConstraints()
*/
/*!
\fn qreal QTextTableFormat::cellSpacing() const
Returns the table's cell spacing. This describes the distance between
adjacent cells.
*/
/*!
\fn void QTextTableFormat::setCellSpacing(qreal spacing)
Sets the cell \a spacing for the table. This determines the distance
between adjacent cells.
*/
/*!
\fn qreal QTextTableFormat::cellPadding() const
Returns the table's cell padding. This describes the distance between
the border of a cell and its contents.
*/
/*!
\fn void QTextTableFormat::setCellPadding(qreal padding)
Sets the cell \a padding for the table. This determines the distance
between the border of a cell and its contents.
*/
/*!
\fn void QTextTableFormat::setAlignment(Qt::Alignment alignment)
Sets the table's \a alignment.
\sa alignment()
*/
/*!
\fn Qt::Alignment QTextTableFormat::alignment() const
Returns the table's alignment.
\sa setAlignment()
*/
/*!
\fn void QTextTableFormat::setHeaderRowCount(int count)
\since 4.2
Declares the first \a count rows of the table as table header.
The table header rows get repeated when a table is broken
across a page boundary.
*/
/*!
\fn int QTextTableFormat::headerRowCount() const
\since 4.2
Returns the number of rows in the table that define the header.
\sa setHeaderRowCount()
*/
/*!
\fn void QTextFormat::setBackground(const QBrush &brush)
Sets the brush use to paint the document's background to the
\a brush specified.
\sa background() clearBackground() setForeground()
*/
/*!
\fn QColor QTextFormat::background() const
Returns the brush used to paint the document's background.
\sa setBackground() clearBackground() foreground()
*/
/*!
\fn void QTextFormat::clearBackground()
Clears the brush used to paint the document's background. The default
brush will be used.
\sa background() setBackground() clearForeground()
*/
/*!
\class QTextImageFormat
\reentrant
\brief The QTextImageFormat class provides formatting information for
images in a QTextDocument.
\ingroup text
Inline images are represented by an object replacement character
(0xFFFC in Unicode) which has an associated QTextImageFormat. The
image format specifies a name with setName() that is used to
locate the image. The size of the rectangle that the image will
occupy is specified using setWidth() and setHeight().
Images can be supplied in any format for which Qt has an image
reader, so SVG drawings can be included alongside PNG, TIFF and
other bitmap formats.
\sa QImage, QImageReader
*/
/*!
\fn QTextImageFormat::QTextImageFormat()
Creates a new image format object.
*/
QTextImageFormat::QTextImageFormat() : QTextCharFormat() { setObjectType(ImageObject); }
/*!
\internal
\fn QTextImageFormat::QTextImageFormat(const QTextFormat &other)
Creates a new image format with the same attributes as the \a given
text format.
*/
QTextImageFormat::QTextImageFormat(const QTextFormat &fmt)
: QTextCharFormat(fmt)
{
}
/*!
\fn bool QTextImageFormat::isValid() const
Returns true if this image format is valid; otherwise returns false.
*/
/*!
\fn void QTextImageFormat::setName(const QString &name)
Sets the \a name of the image. The \a name is used to locate the image
in the application's resources.
\sa name()
*/
/*!
\fn QString QTextImageFormat::name() const
Returns the name of the image. The name refers to an entry in the
application's resources file.
\sa setName()
*/
/*!
\fn void QTextImageFormat::setWidth(qreal width)
Sets the \a width of the rectangle occupied by the image.
\sa width() setHeight()
*/
// ### Qt5 qreal replace with a QTextLength
/*!
\fn qreal QTextImageFormat::width() const
Returns the width of the rectangle occupied by the image.
\sa height() setWidth()
*/
/*!
\fn void QTextImageFormat::setHeight(qreal height)
Sets the \a height of the rectangle occupied by the image.
\sa height() setWidth()
*/
// ### Qt5 qreal replace with a QTextLength
/*!
\fn qreal QTextImageFormat::height() const
Returns the height of the rectangle occupied by the image.
\sa width() setHeight()
*/
/*!
\fn void QTextCharFormat::setFontCapitalization(QFont::Capitalization capitalization)
\since 4.4
Sets the capitalization of the text that apppears in this font to \a capitalization.
A font's capitalization makes the text appear in the selected capitalization mode.
\sa fontCapitalization()
*/
/*!
\fn Capitalization QTextCharFormat::fontCapitalization() const
\since 4.4
Returns the current capitalization type of the font.
*/
/*!
\fn void QTextCharFormat::setFontLetterSpacing(qreal spacing)
\since 4.4
Sets the letter spacing of this format to the given \a spacing, in percent.
A value of 100 indicates default spacing; a value of 200 doubles the amount
of space a letter takes.
\sa fontLetterSpacing()
*/
/*!
\fn qreal QTextCharFormat::fontLetterSpacing() const
\since 4.4
Returns the current letter spacing percentage.
*/
/*!
\fn void QTextCharFormat::setFontWordSpacing(qreal spacing)
\since 4.4
Sets the word spacing of this format to the given \a spacing, in pixels.
\sa fontWordSpacing()
*/
/*!
\fn qreal QTextCharFormat::fontWordSpacing() const
\since 4.4
Returns the current word spacing value.
*/
/*!
\fn qreal QTextTableCellFormat::topPadding() const
\since 4.4
Gets the top padding of the table cell.
\sa setTopPadding(), leftPadding(), rightPadding(), bottomPadding()
*/
/*!
\fn qreal QTextTableCellFormat::bottomPadding() const
\since 4.4
Gets the bottom padding of the table cell.
\sa setBottomPadding(), leftPadding(), rightPadding(), topPadding()
*/
/*!
\fn qreal QTextTableCellFormat::leftPadding() const
\since 4.4
Gets the left padding of the table cell.
\sa setLeftPadding(), rightPadding(), topPadding(), bottomPadding()
*/
/*!
\fn qreal QTextTableCellFormat::rightPadding() const
\since 4.4
Gets the right padding of the table cell.
\sa setRightPadding(), leftPadding(), topPadding(), bottomPadding()
*/
/*!
\fn void QTextTableCellFormat::setTopPadding(qreal padding)
\since 4.4
Sets the top \a padding of the table cell.
\sa topPadding(), setLeftPadding(), setRightPadding(), setBottomPadding()
*/
/*!
\fn void QTextTableCellFormat::setBottomPadding(qreal padding)
\since 4.4
Sets the bottom \a padding of the table cell.
\sa bottomPadding(), setLeftPadding(), setRightPadding(), setTopPadding()
*/
/*!
\fn void QTextTableCellFormat::setLeftPadding(qreal padding)
\since 4.4
Sets the left \a padding of the table cell.
\sa leftPadding(), setRightPadding(), setTopPadding(), setBottomPadding()
*/
/*!
\fn void QTextTableCellFormat::setRightPadding(qreal padding)
\since 4.4
Sets the right \a padding of the table cell.
\sa rightPadding(), setLeftPadding(), setTopPadding(), setBottomPadding()
*/
/*!
\fn void QTextTableCellFormat::setPadding(qreal padding)
\since 4.4
Sets the left, right, top, and bottom \a padding of the table cell.
\sa setLeftPadding(), setRightPadding(), setTopPadding(), setBottomPadding()
*/
/*!
\fn bool QTextTableCellFormat::isValid() const
\since 4.4
Returns true if this table cell format is valid; otherwise returns false.
*/
/*!
\fn QTextTableCellFormat::QTextTableCellFormat()
\since 4.4
Constructs a new table cell format object.
*/
QTextTableCellFormat::QTextTableCellFormat()
: QTextCharFormat()
{
setObjectType(TableCellObject);
}
/*!
\internal
\fn QTextTableCellFormat::QTextTableCellFormat(const QTextFormat &other)
Creates a new table cell format with the same attributes as the \a given
text format.
*/
QTextTableCellFormat::QTextTableCellFormat(const QTextFormat &fmt)
: QTextCharFormat(fmt)
{
}
/*!
\class QTextTableCellFormat
\reentrant
\since 4.4
\brief The QTextTableCellFormat class provides formatting information for
table cells in a QTextDocument.
\ingroup text
The table cell format of a table cell in a document specifies the visual
properties of the table cell.
The padding properties of a table cell are controlled by setLeftPadding(),
setRightPadding(), setTopPadding(), and setBottomPadding(). All the paddings
can be set at once using setPadding().
\sa QTextFormat QTextBlockFormat QTextTableFormat QTextCharFormat
*/
// ------------------------------------------------------
QTextFormatCollection::QTextFormatCollection(const QTextFormatCollection &rhs)
{
formats = rhs.formats;
objFormats = rhs.objFormats;
}
QTextFormatCollection &QTextFormatCollection::operator=(const QTextFormatCollection &rhs)
{
formats = rhs.formats;
objFormats = rhs.objFormats;
return *this;
}
QTextFormatCollection::~QTextFormatCollection()
{
}
int QTextFormatCollection::indexForFormat(const QTextFormat &format)
{
uint hash = format.d ? format.d->hash() : 0;
if (hashes.contains(hash)) {
for (int i = 0; i < formats.size(); ++i) {
if (formats.at(i) == format)
return i;
}
}
int idx = formats.size();
formats.append(format);
QTextFormat &f = formats.last();
if (!f.d)
f.d = new QTextFormatPrivate;
f.d->resolveFont(defaultFnt);
hashes.insert(hash);
return idx;
}
bool QTextFormatCollection::hasFormatCached(const QTextFormat &format) const
{
uint hash = format.d ? format.d->hash() : 0;
if (hashes.contains(hash)) {
for (int i = 0; i < formats.size(); ++i)
if (formats.at(i) == format)
return true;
}
return false;
}
QTextFormat QTextFormatCollection::objectFormat(int objectIndex) const
{
if (objectIndex == -1)
return QTextFormat();
return format(objFormats.at(objectIndex));
}
void QTextFormatCollection::setObjectFormat(int objectIndex, const QTextFormat &f)
{
const int formatIndex = indexForFormat(f);
objFormats[objectIndex] = formatIndex;
}
int QTextFormatCollection::objectFormatIndex(int objectIndex) const
{
if (objectIndex == -1)
return -1;
return objFormats.at(objectIndex);
}
void QTextFormatCollection::setObjectFormatIndex(int objectIndex, int formatIndex)
{
objFormats[objectIndex] = formatIndex;
}
int QTextFormatCollection::createObjectIndex(const QTextFormat &f)
{
const int objectIndex = objFormats.size();
objFormats.append(indexForFormat(f));
return objectIndex;
}
QTextFormat QTextFormatCollection::format(int idx) const
{
if (idx < 0 || idx >= formats.count())
return QTextFormat();
return formats.at(idx);
}
void QTextFormatCollection::setDefaultFont(const QFont &f)
{
defaultFnt = f;
for (int i = 0; i < formats.count(); ++i)
if (formats[i].d)
formats[i].d->resolveFont(defaultFnt);
}
QT_END_NAMESPACE
|