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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qwindow.h"
#include <qpa/qplatformwindow.h>
#include <qpa/qplatformintegration.h>
#ifndef QT_NO_CONTEXTMENU
#include <qpa/qplatformtheme.h>
#endif
#include "qsurfaceformat.h"
#ifndef QT_NO_OPENGL
#include <qpa/qplatformopenglcontext.h>
#include "qopenglcontext.h"
#include "qopenglcontext_p.h"
#endif
#include "qscreen.h"
#include "qwindow_p.h"
#include "qguiapplication_p.h"
#ifndef QT_NO_ACCESSIBILITY
# include "qaccessible.h"
#endif
#include "qhighdpiscaling_p.h"
#if QT_CONFIG(draganddrop)
#include "qshapedpixmapdndwindow_p.h"
#endif // QT_CONFIG(draganddrop)
#include <private/qevent_p.h>
#include <QtCore/QTimer>
#include <QtCore/QDebug>
#include <QStyleHints>
#include <qpa/qplatformcursor.h>
#include <qpa/qplatformwindow_p.h>
QT_BEGIN_NAMESPACE
/*!
\class QWindow
\inmodule QtGui
\since 5.0
\brief The QWindow class represents a window in the underlying windowing system.
A window that is supplied a parent becomes a native child window of
their parent window.
An application will typically use QWidget or QQuickView for its UI, and not
QWindow directly. Still, it is possible to render directly to a QWindow
with QBackingStore or QOpenGLContext, when wanting to keep dependencies to
a minimum or when wanting to use OpenGL directly. The
\l{Raster Window Example} and \l{OpenGL Window Example}
are useful reference examples for how to render to a QWindow using
either approach.
\section1 Resource Management
Windows can potentially use a lot of memory. A usual measurement is
width times height times color depth. A window might also include multiple
buffers to support double and triple buffering, as well as depth and stencil
buffers. To release a window's memory resources, call the destroy() function.
\section1 Content Orientation
QWindow has reportContentOrientationChange() that can be used to specify
the layout of the window contents in relation to the screen. The content
orientation is simply a hint to the windowing system about which
orientation the window contents are in. It's useful when you wish to keep
the same window size, but rotate the contents instead, especially when
doing rotation animations between different orientations. The windowing
system might use this value to determine the layout of system popups or
dialogs.
\section1 Visibility and Windowing System Exposure
By default, the window is not visible, and you must call setVisible(true),
or show() or similar to make it visible. To make a window hidden again,
call setVisible(false) or hide(). The visible property describes the state
the application wants the window to be in. Depending on the underlying
system, a visible window might still not be shown on the screen. It could,
for instance, be covered by other opaque windows or moved outside the
physical area of the screen. On windowing systems that have exposure
notifications, the isExposed() accessor describes whether the window should
be treated as directly visible on screen. The exposeEvent() function is
called whenever an area of the window is invalidated, for example due to the
exposure in the windowing system changing. On windowing systems that do not
make this information visible to the application, isExposed() will simply
return the same value as isVisible().
QWindow::Visibility queried through visibility() is a convenience API
combining the functions of visible() and windowStates().
\section1 Rendering
There are two Qt APIs that can be used to render content into a window,
QBackingStore for rendering with a QPainter and flushing the contents
to a window with type QSurface::RasterSurface, and QOpenGLContext for
rendering with OpenGL to a window with type QSurface::OpenGLSurface.
The application can start rendering as soon as isExposed() returns \c true,
and can keep rendering until it isExposed() returns \c false. To find out when
isExposed() changes, reimplement exposeEvent(). The window will always get
a resize event before the first expose event.
\section1 Initial Geometry
If the window's width and height are left uninitialized, the window will
get a reasonable default geometry from the platform window. If the position
is left uninitialized, then the platform window will allow the windowing
system to position the window. For example on X11, the window manager
usually does some kind of smart positioning to try to avoid having new
windows completely obscure existing windows. However setGeometry()
initializes both the position and the size, so if you want a fixed size but
an automatic position, you should call resize() or setWidth() and
setHeight() instead.
*/
/*!
Creates a window as a top level on the \a targetScreen.
The window is not shown until setVisible(true), show(), or similar is called.
\sa setScreen()
*/
QWindow::QWindow(QScreen *targetScreen)
: QObject(*new QWindowPrivate(), nullptr)
, QSurface(QSurface::Window)
{
Q_D(QWindow);
d->init(targetScreen);
}
static QWindow *nonDesktopParent(QWindow *parent)
{
if (parent && parent->type() == Qt::Desktop) {
qWarning("QWindows cannot be reparented into desktop windows");
return nullptr;
}
return parent;
}
/*!
Creates a window as a child of the given \a parent window.
The window will be embedded inside the parent window, its coordinates
relative to the parent.
The screen is inherited from the parent.
\sa setParent()
*/
QWindow::QWindow(QWindow *parent)
: QWindow(*new QWindowPrivate(), parent)
{
}
/*!
Creates a window as a child of the given \a parent window with the \a dd
private implementation.
The window will be embedded inside the parent window, its coordinates
relative to the parent.
The screen is inherited from the parent.
\internal
\sa setParent()
*/
QWindow::QWindow(QWindowPrivate &dd, QWindow *parent)
: QObject(dd, nonDesktopParent(parent))
, QSurface(QSurface::Window)
{
Q_D(QWindow);
d->init();
}
/*!
Destroys the window.
*/
QWindow::~QWindow()
{
Q_D(QWindow);
d->destroy();
QGuiApplicationPrivate::window_list.removeAll(this);
if (!QGuiApplicationPrivate::is_app_closing)
QGuiApplicationPrivate::instance()->modalWindowList.removeOne(this);
// thse are normally cleared in destroy(), but the window may in
// some cases end up becoming the focus window again, or receive an enter
// event. Clear it again here as a workaround. See QTBUG-75326.
if (QGuiApplicationPrivate::focus_window == this)
QGuiApplicationPrivate::focus_window = nullptr;
if (QGuiApplicationPrivate::currentMouseWindow == this)
QGuiApplicationPrivate::currentMouseWindow = nullptr;
if (QGuiApplicationPrivate::currentMousePressWindow == this)
QGuiApplicationPrivate::currentMousePressWindow = nullptr;
d->isWindow = false;
}
QWindowPrivate::QWindowPrivate()
= default;
QWindowPrivate::~QWindowPrivate()
= default;
void QWindowPrivate::init(QScreen *targetScreen)
{
Q_Q(QWindow);
isWindow = true;
parentWindow = static_cast<QWindow *>(q->QObject::parent());
if (!parentWindow)
connectToScreen(targetScreen ? targetScreen : QGuiApplication::primaryScreen());
// If your application aborts here, you are probably creating a QWindow
// before the screen list is populated.
if (Q_UNLIKELY(!parentWindow && !topLevelScreen)) {
qFatal("Cannot create window: no screens available");
}
QGuiApplicationPrivate::window_list.prepend(q);
requestedFormat = QSurfaceFormat::defaultFormat();
}
/*!
\enum QWindow::Visibility
\since 5.1
This enum describes what part of the screen the window occupies or should
occupy.
\value Windowed The window occupies part of the screen, but not necessarily
the entire screen. This state will occur only on windowing systems which
support showing multiple windows simultaneously. In this state it is
possible for the user to move and resize the window manually, if
WindowFlags permit it and if it is supported by the windowing system.
\value Minimized The window is reduced to an entry or icon on the task bar,
dock, task list or desktop, depending on how the windowing system handles
minimized windows.
\value Maximized The window occupies one entire screen, and the titlebar is
still visible. On most windowing systems this is the state achieved by
clicking the maximize button on the toolbar.
\value FullScreen The window occupies one entire screen, is not resizable,
and there is no titlebar. On some platforms which do not support showing
multiple simultaneous windows, this can be the usual visibility when the
window is not hidden.
\value AutomaticVisibility This means to give the window a default visible
state, which might be fullscreen or windowed depending on the platform.
It can be given as a parameter to setVisibility but will never be
read back from the visibility accessor.
\value Hidden The window is not visible in any way, however it may remember
a latent visibility which can be restored by setting AutomaticVisibility.
*/
/*!
\property QWindow::visibility
\brief the screen-occupation state of the window
\since 5.1
Visibility is whether the window should appear in the windowing system as
normal, minimized, maximized, fullscreen or hidden.
To set the visibility to AutomaticVisibility means to give the window
a default visible state, which might be fullscreen or windowed depending on
the platform.
When reading the visibility property you will always get the actual state,
never AutomaticVisibility.
*/
QWindow::Visibility QWindow::visibility() const
{
Q_D(const QWindow);
return d->visibility;
}
void QWindow::setVisibility(Visibility v)
{
switch (v) {
case Hidden:
hide();
break;
case AutomaticVisibility:
show();
break;
case Windowed:
showNormal();
break;
case Minimized:
showMinimized();
break;
case Maximized:
showMaximized();
break;
case FullScreen:
showFullScreen();
break;
default:
Q_ASSERT(false);
}
}
/*
Subclasses may override this function to run custom setVisible
logic. Subclasses that do so must call the base class implementation
at some point to make the native window visible, and must not
call QWindow::setVisble() since that will recurse back here.
*/
void QWindowPrivate::setVisible(bool visible)
{
Q_Q(QWindow);
if (this->visible != visible) {
this->visible = visible;
emit q->visibleChanged(visible);
updateVisibility();
} else if (platformWindow) {
// Visibility hasn't changed, and the platform window is in sync
return;
}
if (!platformWindow) {
// If we have a parent window, but the parent hasn't been created yet, we
// can defer creation until the parent is created or we're re-parented.
if (parentWindow && !parentWindow->handle())
return;
// We only need to create the window if it's being shown
if (visible) {
// FIXME: At this point we've already updated the visible state of
// the QWindow, so if the platform layer reads the window state during
// creation, and reflects that in the native window, it will end up
// with a visible window. This may in turn result in resize or expose
// events from the platform before we have sent the show event below.
q->create();
}
}
if (visible) {
// remove posted quit events when showing a new window
QCoreApplication::removePostedEvents(qApp, QEvent::Quit);
if (q->type() == Qt::Window) {
QGuiApplicationPrivate *app_priv = QGuiApplicationPrivate::instance();
QString &firstWindowTitle = app_priv->firstWindowTitle;
if (!firstWindowTitle.isEmpty()) {
q->setTitle(firstWindowTitle);
firstWindowTitle = QString();
}
if (!app_priv->forcedWindowIcon.isNull())
q->setIcon(app_priv->forcedWindowIcon);
// Handling of the -qwindowgeometry, -geometry command line arguments
static bool geometryApplied = false;
if (!geometryApplied) {
geometryApplied = true;
QGuiApplicationPrivate::applyWindowGeometrySpecificationTo(q);
}
}
QShowEvent showEvent;
QGuiApplication::sendEvent(q, &showEvent);
}
if (q->isModal()) {
if (visible)
QGuiApplicationPrivate::showModalWindow(q);
else
QGuiApplicationPrivate::hideModalWindow(q);
// QShapedPixmapWindow is used on some platforms for showing a drag pixmap, so don't block
// input to this window as it is performing a drag - QTBUG-63846
} else if (visible && QGuiApplication::modalWindow()
#if QT_CONFIG(draganddrop)
&& !qobject_cast<QShapedPixmapWindow *>(q)
#endif // QT_CONFIG(draganddrop)
) {
QGuiApplicationPrivate::updateBlockedStatus(q);
}
#ifndef QT_NO_CURSOR
if (visible && (hasCursor || QGuiApplication::overrideCursor()))
applyCursor();
#endif
if (platformWindow)
platformWindow->setVisible(visible);
if (!visible) {
QHideEvent hideEvent;
QGuiApplication::sendEvent(q, &hideEvent);
}
}
void QWindowPrivate::updateVisibility()
{
Q_Q(QWindow);
QWindow::Visibility old = visibility;
if (!visible)
visibility = QWindow::Hidden;
else if (windowState & Qt::WindowMinimized)
visibility = QWindow::Minimized;
else if (windowState & Qt::WindowFullScreen)
visibility = QWindow::FullScreen;
else if (windowState & Qt::WindowMaximized)
visibility = QWindow::Maximized;
else
visibility = QWindow::Windowed;
if (visibility != old)
emit q->visibilityChanged(visibility);
}
void QWindowPrivate::updateSiblingPosition(SiblingPosition position)
{
Q_Q(QWindow);
if (!q->parent())
return;
QObjectList &siblings = q->parent()->d_ptr->children;
const int siblingCount = siblings.size() - 1;
if (siblingCount == 0)
return;
const int currentPosition = siblings.indexOf(q);
Q_ASSERT(currentPosition >= 0);
const int targetPosition = position == PositionTop ? siblingCount : 0;
if (currentPosition == targetPosition)
return;
siblings.move(currentPosition, targetPosition);
}
bool QWindowPrivate::windowRecreationRequired(QScreen *newScreen) const
{
Q_Q(const QWindow);
const QScreen *oldScreen = q->screen();
return oldScreen != newScreen && (platformWindow || !oldScreen)
&& !(oldScreen && oldScreen->virtualSiblings().contains(newScreen));
}
void QWindowPrivate::disconnectFromScreen()
{
if (topLevelScreen)
topLevelScreen = nullptr;
}
void QWindowPrivate::connectToScreen(QScreen *screen)
{
disconnectFromScreen();
topLevelScreen = screen;
}
void QWindowPrivate::emitScreenChangedRecursion(QScreen *newScreen)
{
Q_Q(QWindow);
emit q->screenChanged(newScreen);
for (QObject *child : q->children()) {
if (child->isWindowType())
static_cast<QWindow *>(child)->d_func()->emitScreenChangedRecursion(newScreen);
}
}
void QWindowPrivate::setTopLevelScreen(QScreen *newScreen, bool recreate)
{
Q_Q(QWindow);
if (parentWindow) {
qWarning() << q << '(' << newScreen << "): Attempt to set a screen on a child window.";
return;
}
if (newScreen != topLevelScreen) {
const bool shouldRecreate = recreate && windowRecreationRequired(newScreen);
const bool shouldShow = visibilityOnDestroy && !topLevelScreen;
if (shouldRecreate && platformWindow)
q->destroy();
connectToScreen(newScreen);
if (shouldShow)
q->setVisible(true);
else if (newScreen && shouldRecreate)
create(true);
emitScreenChangedRecursion(newScreen);
}
}
void QWindowPrivate::create(bool recursive, WId nativeHandle)
{
Q_Q(QWindow);
if (platformWindow)
return;
// avoid losing update requests when re-creating
const bool needsUpdate = updateRequestPending;
// the platformWindow, if there was one, is now gone, so make this flag reflect reality now
updateRequestPending = false;
if (q->parent())
q->parent()->create();
// QPlatformWindow will poll geometry() during construction below. Set the
// screen here so that high-dpi scaling will use the correct scale factor.
if (q->isTopLevel()) {
if (QScreen *screen = screenForGeometry(geometry))
setTopLevelScreen(screen, false);
}
QPlatformIntegration *platformIntegration = QGuiApplicationPrivate::platformIntegration();
platformWindow = nativeHandle ? platformIntegration->createForeignWindow(q, nativeHandle)
: platformIntegration->createPlatformWindow(q);
Q_ASSERT(platformWindow);
if (!platformWindow) {
qWarning() << "Failed to create platform window for" << q << "with flags" << q->flags();
return;
}
platformWindow->initialize();
QObjectList childObjects = q->children();
for (int i = 0; i < childObjects.size(); i ++) {
QObject *object = childObjects.at(i);
if (!object->isWindowType())
continue;
QWindow *childWindow = static_cast<QWindow *>(object);
if (recursive)
childWindow->d_func()->create(recursive);
// The child may have had deferred creation due to this window not being created
// at the time setVisible was called, so we re-apply the visible state, which
// may result in creating the child, and emitting the appropriate signals.
if (childWindow->isVisible())
childWindow->setVisible(true);
if (QPlatformWindow *childPlatformWindow = childWindow->d_func()->platformWindow)
childPlatformWindow->setParent(this->platformWindow);
}
QPlatformSurfaceEvent e(QPlatformSurfaceEvent::SurfaceCreated);
QGuiApplication::sendEvent(q, &e);
if (needsUpdate)
q->requestUpdate();
}
void QWindowPrivate::clearFocusObject()
{
}
// Allows for manipulating the suggested geometry before a resize/move
// event in derived classes for platforms that support it, for example to
// implement heightForWidth().
QRectF QWindowPrivate::closestAcceptableGeometry(const QRectF &rect) const
{
Q_UNUSED(rect);
return QRectF();
}
/*!
Sets the \a surfaceType of the window.
Specifies whether the window is meant for raster rendering with
QBackingStore, or OpenGL rendering with QOpenGLContext.
The surfaceType will be used when the native surface is created
in the create() function. Calling this function after the native
surface has been created requires calling destroy() and create()
to release the old native surface and create a new one.
\sa QBackingStore, QOpenGLContext, create(), destroy()
*/
void QWindow::setSurfaceType(SurfaceType surfaceType)
{
Q_D(QWindow);
d->surfaceType = surfaceType;
}
/*!
Returns the surface type of the window.
\sa setSurfaceType()
*/
QWindow::SurfaceType QWindow::surfaceType() const
{
Q_D(const QWindow);
return d->surfaceType;
}
/*!
\property QWindow::visible
\brief whether the window is visible or not
This property controls the visibility of the window in the windowing system.
By default, the window is not visible, you must call setVisible(true), or
show() or similar to make it visible.
\note Hiding a window does not remove the window from the windowing system,
it only hides it. On windowing systems that give full screen applications a
dedicated desktop (such as macOS), hiding a full screen window will not remove
that desktop, but leave it blank. Another window from the same application
might be shown full screen, and will fill that desktop. Use QWindow::close to
completely remove a window from the windowing system.
\sa show()
*/
void QWindow::setVisible(bool visible)
{
Q_D(QWindow);
d->setVisible(visible);
}
bool QWindow::isVisible() const
{
Q_D(const QWindow);
return d->visible;
}
/*!
Allocates the platform resources associated with the window.
It is at this point that the surface format set using setFormat() gets resolved
into an actual native surface. However, the window remains hidden until setVisible() is called.
Note that it is not usually necessary to call this function directly, as it will be implicitly
called by show(), setVisible(), and other functions that require access to the platform
resources.
Call destroy() to free the platform resources if necessary.
\sa destroy()
*/
void QWindow::create()
{
Q_D(QWindow);
d->create(false);
}
/*!
Returns the window's platform id.
For platforms where this id might be useful, the value returned
will uniquely represent the window inside the corresponding screen.
\sa screen()
*/
WId QWindow::winId() const
{
Q_D(const QWindow);
if (!d->platformWindow)
const_cast<QWindow *>(this)->create();
return d->platformWindow->winId();
}
/*!
Returns the parent window, if any.
If \a mode is IncludeTransients, then the transient parent is returned
if there is no parent.
A window without a parent is known as a top level window.
\since 5.9
*/
QWindow *QWindow::parent(AncestorMode mode) const
{
Q_D(const QWindow);
return d->parentWindow ? d->parentWindow : (mode == IncludeTransients ? transientParent() : nullptr);
}
/*!
Sets the \a parent Window. This will lead to the windowing system managing
the clip of the window, so it will be clipped to the \a parent window.
Setting \a parent to be \nullptr will make the window become a top level
window.
If \a parent is a window created by fromWinId(), then the current window
will be embedded inside \a parent, if the platform supports it.
*/
void QWindow::setParent(QWindow *parent)
{
parent = nonDesktopParent(parent);
Q_D(QWindow);
if (d->parentWindow == parent)
return;
QScreen *newScreen = parent ? parent->screen() : screen();
if (d->windowRecreationRequired(newScreen)) {
qWarning() << this << '(' << parent << "): Cannot change screens (" << screen() << newScreen << ')';
return;
}
QObject::setParent(parent);
d->parentWindow = parent;
if (parent)
d->disconnectFromScreen();
else
d->connectToScreen(newScreen);
// If we were set visible, but not created because we were a child, and we're now
// re-parented into a created parent, or to being a top level, we need re-apply the
// visibility state, which will also create.
if (isVisible() && (!parent || parent->handle()))
setVisible(true);
if (d->platformWindow) {
if (parent)
parent->create();
d->platformWindow->setParent(parent ? parent->d_func()->platformWindow : nullptr);
}
QGuiApplicationPrivate::updateBlockedStatus(this);
}
/*!
Returns whether the window is top level, i.e. has no parent window.
*/
bool QWindow::isTopLevel() const
{
Q_D(const QWindow);
return d->parentWindow == nullptr;
}
/*!
Returns whether the window is modal.
A modal window prevents other windows from getting any input.
\sa QWindow::modality
*/
bool QWindow::isModal() const
{
Q_D(const QWindow);
return d->modality != Qt::NonModal;
}
/*! \property QWindow::modality
\brief the modality of the window
A modal window prevents other windows from receiving input events. Qt
supports two types of modality: Qt::WindowModal and Qt::ApplicationModal.
By default, this property is Qt::NonModal
\sa Qt::WindowModality
*/
Qt::WindowModality QWindow::modality() const
{
Q_D(const QWindow);
return d->modality;
}
void QWindow::setModality(Qt::WindowModality modality)
{
Q_D(QWindow);
if (d->modality == modality)
return;
d->modality = modality;
emit modalityChanged(modality);
}
/*! \fn void QWindow::modalityChanged(Qt::WindowModality modality)
This signal is emitted when the Qwindow::modality property changes to \a modality.
*/
/*!
Sets the window's surface \a format.
The format determines properties such as color depth, alpha, depth and
stencil buffer size, etc. For example, to give a window a transparent
background (provided that the window system supports compositing, and
provided that other content in the window does not make it opaque again):
\code
QSurfaceFormat format;
format.setAlphaBufferSize(8);
window.setFormat(format);
\endcode
The surface format will be resolved in the create() function. Calling
this function after create() has been called will not re-resolve the
surface format of the native surface.
When the format is not explicitly set via this function, the format returned
by QSurfaceFormat::defaultFormat() will be used. This means that when having
multiple windows, individual calls to this function can be replaced by one
single call to QSurfaceFormat::setDefaultFormat() before creating the first
window.
\sa create(), destroy(), QSurfaceFormat::setDefaultFormat()
*/
void QWindow::setFormat(const QSurfaceFormat &format)
{
Q_D(QWindow);
d->requestedFormat = format;
}
/*!
Returns the requested surface format of this window.
If the requested format was not supported by the platform implementation,
the requestedFormat will differ from the actual window format.
This is the value set with setFormat().
\sa setFormat(), format()
*/
QSurfaceFormat QWindow::requestedFormat() const
{
Q_D(const QWindow);
return d->requestedFormat;
}
/*!
Returns the actual format of this window.
After the window has been created, this function will return the actual surface format
of the window. It might differ from the requested format if the requested format could
not be fulfilled by the platform. It might also be a superset, for example certain
buffer sizes may be larger than requested.
\note Depending on the platform, certain values in this surface format may still
contain the requested values, that is, the values that have been passed to
setFormat(). Typical examples are the OpenGL version, profile and options. These may
not get updated during create() since these are context specific and a single window
may be used together with multiple contexts over its lifetime. Use the
QOpenGLContext's format() instead to query such values.
\sa create(), requestedFormat(), QOpenGLContext::format()
*/
QSurfaceFormat QWindow::format() const
{
Q_D(const QWindow);
if (d->platformWindow)
return d->platformWindow->format();
return d->requestedFormat;
}
/*!
\property QWindow::flags
\brief the window flags of the window
The window flags control the window's appearance in the windowing system,
whether it's a dialog, popup, or a regular window, and whether it should
have a title bar, etc.
The actual window flags might differ from the flags set with setFlags()
if the requested flags could not be fulfilled.
\sa setFlag()
*/
void QWindow::setFlags(Qt::WindowFlags flags)
{
Q_D(QWindow);
if (d->windowFlags == flags)
return;
if (d->platformWindow)
d->platformWindow->setWindowFlags(flags);
d->windowFlags = flags;
}
Qt::WindowFlags QWindow::flags() const
{
Q_D(const QWindow);
Qt::WindowFlags flags = d->windowFlags;
if (d->platformWindow && d->platformWindow->isForeignWindow())
flags |= Qt::ForeignWindow;
return flags;
}
/*!
\since 5.9
Sets the window flag \a flag on this window if \a on is true;
otherwise clears the flag.
\sa setFlags(), flags(), type()
*/
void QWindow::setFlag(Qt::WindowType flag, bool on)
{
Q_D(QWindow);
if (on)
setFlags(d->windowFlags | flag);
else
setFlags(d->windowFlags & ~flag);
}
/*!
Returns the type of the window.
This returns the part of the window flags that represents
whether the window is a dialog, tooltip, popup, regular window, etc.
\sa flags(), setFlags()
*/
Qt::WindowType QWindow::type() const
{
return static_cast<Qt::WindowType>(int(flags() & Qt::WindowType_Mask));
}
/*!
\property QWindow::title
\brief the window's title in the windowing system
The window title might appear in the title area of the window decorations,
depending on the windowing system and the window flags. It might also
be used by the windowing system to identify the window in other contexts,
such as in the task switcher.
\sa flags()
*/
void QWindow::setTitle(const QString &title)
{
Q_D(QWindow);
bool changed = false;
if (d->windowTitle != title) {
d->windowTitle = title;
changed = true;
}
if (d->platformWindow && type() != Qt::Desktop)
d->platformWindow->setWindowTitle(title);
if (changed)
emit windowTitleChanged(title);
}
QString QWindow::title() const
{
Q_D(const QWindow);
return d->windowTitle;
}
/*!
\brief set the file name this window is representing.
The windowing system might use \a filePath to display the
path of the document this window is representing in the tile bar.
*/
void QWindow::setFilePath(const QString &filePath)
{
Q_D(QWindow);
d->windowFilePath = filePath;
if (d->platformWindow)
d->platformWindow->setWindowFilePath(filePath);
}
/*!
\brief the file name this window is representing.
\sa setFilePath()
*/
QString QWindow::filePath() const
{
Q_D(const QWindow);
return d->windowFilePath;
}
/*!
\brief Sets the window's \a icon in the windowing system
The window icon might be used by the windowing system for example to
decorate the window, and/or in the task switcher.
\note On \macos, the window title bar icon is meant for windows representing
documents, and will only show up if a file path is also set.
\sa setFilePath()
*/
void QWindow::setIcon(const QIcon &icon)
{
Q_D(QWindow);
d->windowIcon = icon;
if (d->platformWindow)
d->platformWindow->setWindowIcon(icon);
QEvent e(QEvent::WindowIconChange);
QCoreApplication::sendEvent(this, &e);
}
/*!
\brief Returns the window's icon in the windowing system
\sa setIcon()
*/
QIcon QWindow::icon() const
{
Q_D(const QWindow);
if (d->windowIcon.isNull())
return QGuiApplication::windowIcon();
return d->windowIcon;
}
/*!
Raise the window in the windowing system.
Requests that the window be raised to appear above other windows.
*/
void QWindow::raise()
{
Q_D(QWindow);
d->updateSiblingPosition(QWindowPrivate::PositionTop);
if (d->platformWindow)
d->platformWindow->raise();
}
/*!
Lower the window in the windowing system.
Requests that the window be lowered to appear below other windows.
*/
void QWindow::lower()
{
Q_D(QWindow);
d->updateSiblingPosition(QWindowPrivate::PositionBottom);
if (d->platformWindow)
d->platformWindow->lower();
}
/*!
\brief Start a system-specific resize operation
\since 5.15
Calling this will start an interactive resize operation on the window by platforms
that support it. The actual behavior may vary depending on the platform. Usually,
it will make the window resize so that its edge follows the mouse cursor.
On platforms that support it, this method of resizing windows is preferred over
\c setGeometry, because it allows a more native look and feel of resizing windows, e.g.
letting the window manager snap this window against other windows, or special resizing
behavior with animations when dragged to the edge of the screen.
\a edges should either be a single edge, or two adjacent edges (a corner). Other values
are not allowed.
Returns true if the operation was supported by the system.
*/
bool QWindow::startSystemResize(Qt::Edges edges)
{
Q_D(QWindow);
if (Q_UNLIKELY(!isVisible() || !d->platformWindow || d->maximumSize == d->minimumSize))
return false;
const bool isSingleEdge = edges == Qt::TopEdge || edges == Qt::RightEdge || edges == Qt::BottomEdge || edges == Qt::LeftEdge;
const bool isCorner =
edges == (Qt::TopEdge | Qt::LeftEdge) ||
edges == (Qt::TopEdge | Qt::RightEdge) ||
edges == (Qt::BottomEdge | Qt::RightEdge) ||
edges == (Qt::BottomEdge | Qt::LeftEdge);
if (Q_UNLIKELY(!isSingleEdge && !isCorner)) {
qWarning() << "Invalid edges" << edges << "passed to QWindow::startSystemResize, ignoring.";
return false;
}
return d->platformWindow->startSystemResize(edges);
}
/*!
\brief Start a system-specific move operation
\since 5.15
Calling this will start an interactive move operation on the window by platforms
that support it. The actual behavior may vary depending on the platform. Usually,
it will make the window follow the mouse cursor until a mouse button is released.
On platforms that support it, this method of moving windows is preferred over
\c setPosition, because it allows a more native look-and-feel of moving windows, e.g.
letting the window manager snap this window against other windows, or special tiling
or resizing behavior with animations when dragged to the edge of the screen.
Furthermore, on some platforms such as Wayland, \c setPosition is not supported, so
this is the only way the application can influence its position.
Returns true if the operation was supported by the system.
*/
bool QWindow::startSystemMove()
{
Q_D(QWindow);
if (Q_UNLIKELY(!isVisible() || !d->platformWindow))
return false;
return d->platformWindow->startSystemMove();
}
/*!
\property QWindow::opacity
\brief The opacity of the window in the windowing system.
\since 5.1
If the windowing system supports window opacity, this can be used to fade the
window in and out, or to make it semitransparent.
A value of 1.0 or above is treated as fully opaque, whereas a value of 0.0 or below
is treated as fully transparent. Values inbetween represent varying levels of
translucency between the two extremes.
The default value is 1.0.
*/
void QWindow::setOpacity(qreal level)
{
Q_D(QWindow);
if (level == d->opacity)
return;
d->opacity = level;
if (d->platformWindow) {
d->platformWindow->setOpacity(level);
emit opacityChanged(level);
}
}
qreal QWindow::opacity() const
{
Q_D(const QWindow);
return d->opacity;
}
/*!
Sets the mask of the window.
The mask is a hint to the windowing system that the application does not
want to receive mouse or touch input outside the given \a region.
The window manager may or may not choose to display any areas of the window
not included in the mask, thus it is the application's responsibility to
clear to transparent the areas that are not part of the mask.
*/
void QWindow::setMask(const QRegion ®ion)
{
Q_D(QWindow);
if (d->platformWindow)
d->platformWindow->setMask(QHighDpi::toNativeLocalRegion(region, this));
d->mask = region;
}
/*!
Returns the mask set on the window.
The mask is a hint to the windowing system that the application does not
want to receive mouse or touch input outside the given region.
*/
QRegion QWindow::mask() const
{
Q_D(const QWindow);
return d->mask;
}
/*!
Requests the window to be activated, i.e. receive keyboard focus.
\sa isActive(), QGuiApplication::focusWindow()
*/
void QWindow::requestActivate()
{
Q_D(QWindow);
if (flags() & Qt::WindowDoesNotAcceptFocus) {
qWarning() << "requestActivate() called for " << this << " which has Qt::WindowDoesNotAcceptFocus set.";
return;
}
if (d->platformWindow)
d->platformWindow->requestActivateWindow();
}
/*!
Returns if this window is exposed in the windowing system.
When the window is not exposed, it is shown by the application
but it is still not showing in the windowing system, so the application
should minimize animations and other graphical activities.
An exposeEvent() is sent every time this value changes.
\sa exposeEvent()
*/
bool QWindow::isExposed() const
{
Q_D(const QWindow);
return d->exposed;
}
/*!
\property QWindow::active
\brief the active status of the window
\since 5.1
\sa requestActivate()
*/
/*!
Returns \c true if the window is active.
This is the case for the window that has input focus as well as windows
that are in the same parent / transient parent chain as the focus window.
Typically active windows should appear active from a style perspective.
To get the window that currently has focus, use QGuiApplication::focusWindow().
*/
bool QWindow::isActive() const
{
Q_D(const QWindow);
if (!d->platformWindow)
return false;
QWindow *focus = QGuiApplication::focusWindow();
// Means the whole application lost the focus
if (!focus)
return false;
if (focus == this)
return true;
if (QWindow *p = parent(IncludeTransients))
return p->isActive();
else
return isAncestorOf(focus);
}
/*!
\property QWindow::contentOrientation
\brief the orientation of the window's contents
This is a hint to the window manager in case it needs to display
additional content like popups, dialogs, status bars, or similar
in relation to the window.
The recommended orientation is QScreen::orientation() but
an application doesn't have to support all possible orientations,
and thus can opt to ignore the current screen orientation.
The difference between the window and the content orientation
determines how much to rotate the content by. QScreen::angleBetween(),
QScreen::transformBetween(), and QScreen::mapBetween() can be used
to compute the necessary transform.
The default value is Qt::PrimaryOrientation
*/
void QWindow::reportContentOrientationChange(Qt::ScreenOrientation orientation)
{
Q_D(QWindow);
if (d->contentOrientation == orientation)
return;
if (d->platformWindow)
d->platformWindow->handleContentOrientationChange(orientation);
d->contentOrientation = orientation;
emit contentOrientationChanged(orientation);
}
Qt::ScreenOrientation QWindow::contentOrientation() const
{
Q_D(const QWindow);
return d->contentOrientation;
}
/*!
Returns the ratio between physical pixels and device-independent pixels
for the window. This value is dependent on the screen the window is on,
and may change when the window is moved.
Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays.
\note For windows not backed by a platform window, meaning that create() was not
called, the function will fall back to the associated QScreen's device pixel ratio.
\sa QScreen::devicePixelRatio()
*/
qreal QWindow::devicePixelRatio() const
{
Q_D(const QWindow);
// If there is no platform window use the associated screen's devicePixelRatio,
// which typically is the primary screen and will be correct for single-display
// systems (a very common case).
if (!d->platformWindow)
return screen()->devicePixelRatio();
return d->platformWindow->devicePixelRatio() * QHighDpiScaling::factor(this);
}
Qt::WindowState QWindowPrivate::effectiveState(Qt::WindowStates state)
{
if (state & Qt::WindowMinimized)
return Qt::WindowMinimized;
else if (state & Qt::WindowFullScreen)
return Qt::WindowFullScreen;
else if (state & Qt::WindowMaximized)
return Qt::WindowMaximized;
return Qt::WindowNoState;
}
/*!
\brief set the screen-occupation state of the window
The window \a state represents whether the window appears in the
windowing system as maximized, minimized, fullscreen, or normal.
The enum value Qt::WindowActive is not an accepted parameter.
\sa showNormal(), showFullScreen(), showMinimized(), showMaximized(), setWindowStates()
*/
void QWindow::setWindowState(Qt::WindowState state)
{
setWindowStates(state);
}
/*!
\brief set the screen-occupation state of the window
\since 5.10
The window \a state represents whether the window appears in the
windowing system as maximized, minimized and/or fullscreen.
The window can be in a combination of several states. For example, if
the window is both minimized and maximized, the window will appear
minimized, but clicking on the task bar entry will restore it to the
maximized state.
The enum value Qt::WindowActive should not be set.
\sa showNormal(), showFullScreen(), showMinimized(), showMaximized()
*/
void QWindow::setWindowStates(Qt::WindowStates state)
{
Q_D(QWindow);
if (state & Qt::WindowActive) {
qWarning("QWindow::setWindowStates does not accept Qt::WindowActive");
state &= ~Qt::WindowActive;
}
if (d->platformWindow)
d->platformWindow->setWindowState(state);
d->windowState = state;
emit windowStateChanged(QWindowPrivate::effectiveState(d->windowState));
d->updateVisibility();
}
/*!
\brief the screen-occupation state of the window
\sa setWindowState(), windowStates()
*/
Qt::WindowState QWindow::windowState() const
{
Q_D(const QWindow);
return QWindowPrivate::effectiveState(d->windowState);
}
/*!
\brief the screen-occupation state of the window
\since 5.10
The window can be in a combination of several states. For example, if
the window is both minimized and maximized, the window will appear
minimized, but clicking on the task bar entry will restore it to
the maximized state.
\sa setWindowStates()
*/
Qt::WindowStates QWindow::windowStates() const
{
Q_D(const QWindow);
return d->windowState;
}
/*!
\fn QWindow::windowStateChanged(Qt::WindowState windowState)
This signal is emitted when the \a windowState changes, either
by being set explicitly with setWindowStates(), or automatically when
the user clicks one of the titlebar buttons or by other means.
*/
/*!
\property QWindow::transientParent
\brief the window for which this window is a transient pop-up
\since 5.13
This is a hint to the window manager that this window is a dialog or pop-up
on behalf of the transient parent.
In order to cause the window to be centered above its transient \a parent by
default, depending on the window manager, it may also be necessary to call
setFlags() with a suitable \l Qt::WindowType (such as \c Qt::Dialog).
\sa parent()
*/
void QWindow::setTransientParent(QWindow *parent)
{
Q_D(QWindow);
if (parent && !parent->isTopLevel()) {
qWarning() << parent << "must be a top level window.";
return;
}
if (parent == this) {
qWarning() << "transient parent" << parent << "cannot be same as window";
return;
}
d->transientParent = parent;
QGuiApplicationPrivate::updateBlockedStatus(this);
emit transientParentChanged(parent);
}
QWindow *QWindow::transientParent() const
{
Q_D(const QWindow);
return d->transientParent.data();
}
/*
The setter for the QWindow::transientParent property.
The only reason this exists is to set the transientParentPropertySet flag
so that Qt Quick knows whether it was set programmatically (because of
Window declaration context) or because the user set the property.
*/
void QWindowPrivate::setTransientParent(QWindow *parent)
{
Q_Q(QWindow);
q->setTransientParent(parent);
transientParentPropertySet = true;
}
/*!
\enum QWindow::AncestorMode
This enum is used to control whether or not transient parents
should be considered ancestors.
\value ExcludeTransients Transient parents are not considered ancestors.
\value IncludeTransients Transient parents are considered ancestors.
*/
/*!
Returns \c true if the window is an ancestor of the given \a child. If \a mode
is IncludeTransients, then transient parents are also considered ancestors.
*/
bool QWindow::isAncestorOf(const QWindow *child, AncestorMode mode) const
{
if (child->parent() == this || (mode == IncludeTransients && child->transientParent() == this))
return true;
if (QWindow *parent = child->parent(mode)) {
if (isAncestorOf(parent, mode))
return true;
} else if (handle() && child->handle()) {
if (handle()->isAncestorOf(child->handle()))
return true;
}
return false;
}
/*!
Returns the minimum size of the window.
\sa setMinimumSize()
*/
QSize QWindow::minimumSize() const
{
Q_D(const QWindow);
return d->minimumSize;
}
/*!
Returns the maximum size of the window.
\sa setMaximumSize()
*/
QSize QWindow::maximumSize() const
{
Q_D(const QWindow);
return d->maximumSize;
}
/*!
Returns the base size of the window.
\sa setBaseSize()
*/
QSize QWindow::baseSize() const
{
Q_D(const QWindow);
return d->baseSize;
}
/*!
Returns the size increment of the window.
\sa setSizeIncrement()
*/
QSize QWindow::sizeIncrement() const
{
Q_D(const QWindow);
return d->sizeIncrement;
}
/*!
Sets the minimum size of the window.
This is a hint to the window manager to prevent resizing below the specified \a size.
\sa setMaximumSize(), minimumSize()
*/
void QWindow::setMinimumSize(const QSize &size)
{
Q_D(QWindow);
QSize adjustedSize = QSize(qBound(0, size.width(), QWINDOWSIZE_MAX), qBound(0, size.height(), QWINDOWSIZE_MAX));
if (d->minimumSize == adjustedSize)
return;
QSize oldSize = d->minimumSize;
d->minimumSize = adjustedSize;
if (d->platformWindow && isTopLevel())
d->platformWindow->propagateSizeHints();
if (d->minimumSize.width() != oldSize.width())
emit minimumWidthChanged(d->minimumSize.width());
if (d->minimumSize.height() != oldSize.height())
emit minimumHeightChanged(d->minimumSize.height());
}
/*!
\property QWindow::x
\brief the x position of the window's geometry
*/
void QWindow::setX(int arg)
{
Q_D(QWindow);
if (x() != arg)
setGeometry(QRect(arg, y(), width(), height()));
else
d->positionAutomatic = false;
}
/*!
\property QWindow::y
\brief the y position of the window's geometry
*/
void QWindow::setY(int arg)
{
Q_D(QWindow);
if (y() != arg)
setGeometry(QRect(x(), arg, width(), height()));
else
d->positionAutomatic = false;
}
/*!
\property QWindow::width
\brief the width of the window's geometry
*/
void QWindow::setWidth(int arg)
{
if (width() != arg)
resize(arg, height());
}
/*!
\property QWindow::height
\brief the height of the window's geometry
*/
void QWindow::setHeight(int arg)
{
if (height() != arg)
resize(width(), arg);
}
/*!
\property QWindow::minimumWidth
\brief the minimum width of the window's geometry
*/
void QWindow::setMinimumWidth(int w)
{
setMinimumSize(QSize(w, minimumHeight()));
}
/*!
\property QWindow::minimumHeight
\brief the minimum height of the window's geometry
*/
void QWindow::setMinimumHeight(int h)
{
setMinimumSize(QSize(minimumWidth(), h));
}
/*!
Sets the maximum size of the window.
This is a hint to the window manager to prevent resizing above the specified \a size.
\sa setMinimumSize(), maximumSize()
*/
void QWindow::setMaximumSize(const QSize &size)
{
Q_D(QWindow);
QSize adjustedSize = QSize(qBound(0, size.width(), QWINDOWSIZE_MAX), qBound(0, size.height(), QWINDOWSIZE_MAX));
if (d->maximumSize == adjustedSize)
return;
QSize oldSize = d->maximumSize;
d->maximumSize = adjustedSize;
if (d->platformWindow && isTopLevel())
d->platformWindow->propagateSizeHints();
if (d->maximumSize.width() != oldSize.width())
emit maximumWidthChanged(d->maximumSize.width());
if (d->maximumSize.height() != oldSize.height())
emit maximumHeightChanged(d->maximumSize.height());
}
/*!
\property QWindow::maximumWidth
\brief the maximum width of the window's geometry
*/
void QWindow::setMaximumWidth(int w)
{
setMaximumSize(QSize(w, maximumHeight()));
}
/*!
\property QWindow::maximumHeight
\brief the maximum height of the window's geometry
*/
void QWindow::setMaximumHeight(int h)
{
setMaximumSize(QSize(maximumWidth(), h));
}
/*!
Sets the base \a size of the window.
The base size is used to calculate a proper window size if the
window defines sizeIncrement().
\sa setMinimumSize(), setMaximumSize(), setSizeIncrement(), baseSize()
*/
void QWindow::setBaseSize(const QSize &size)
{
Q_D(QWindow);
if (d->baseSize == size)
return;
d->baseSize = size;
if (d->platformWindow && isTopLevel())
d->platformWindow->propagateSizeHints();
}
/*!
Sets the size increment (\a size) of the window.
When the user resizes the window, the size will move in steps of
sizeIncrement().width() pixels horizontally and
sizeIncrement().height() pixels vertically, with baseSize() as the
basis.
By default, this property contains a size with zero width and height.
The windowing system might not support size increments.
\sa setBaseSize(), setMinimumSize(), setMaximumSize()
*/
void QWindow::setSizeIncrement(const QSize &size)
{
Q_D(QWindow);
if (d->sizeIncrement == size)
return;
d->sizeIncrement = size;
if (d->platformWindow && isTopLevel())
d->platformWindow->propagateSizeHints();
}
/*!
Sets the geometry of the window, excluding its window frame, to a
rectangle constructed from \a posx, \a posy, \a w and \a h.
The geometry is in relation to the virtualGeometry() of its screen.
\sa geometry()
*/
void QWindow::setGeometry(int posx, int posy, int w, int h)
{
setGeometry(QRect(posx, posy, w, h));
}
/*!
\brief Sets the geometry of the window, excluding its window frame, to \a rect.
The geometry is in relation to the virtualGeometry() of its screen.
\sa geometry()
*/
void QWindow::setGeometry(const QRect &rect)
{
Q_D(QWindow);
d->positionAutomatic = false;
const QRect oldRect = geometry();
if (rect == oldRect)
return;
d->positionPolicy = QWindowPrivate::WindowFrameExclusive;
if (d->platformWindow) {
QScreen *newScreen = d->screenForGeometry(rect);
if (newScreen && isTopLevel())
d->setTopLevelScreen(newScreen, true);
d->platformWindow->setGeometry(QHighDpi::toNativeWindowGeometry(rect, this));
} else {
d->geometry = rect;
if (rect.x() != oldRect.x())
emit xChanged(rect.x());
if (rect.y() != oldRect.y())
emit yChanged(rect.y());
if (rect.width() != oldRect.width())
emit widthChanged(rect.width());
if (rect.height() != oldRect.height())
emit heightChanged(rect.height());
}
}
/*
This is equivalent to QPlatformWindow::screenForGeometry, but in platform
independent coordinates. The duplication is unfortunate, but there is a
chicken and egg problem here: we cannot convert to native coordinates
before we know which screen we are on.
*/
QScreen *QWindowPrivate::screenForGeometry(const QRect &newGeometry) const
{
Q_Q(const QWindow);
QScreen *currentScreen = q->screen();
QScreen *fallback = currentScreen;
QPoint center = newGeometry.center();
if (!q->parent() && currentScreen && !currentScreen->geometry().contains(center)) {
const auto screens = currentScreen->virtualSiblings();
for (QScreen* screen : screens) {
if (screen->geometry().contains(center))
return screen;
if (screen->geometry().intersects(newGeometry))
fallback = screen;
}
}
return fallback;
}
/*!
Returns the geometry of the window, excluding its window frame.
The geometry is in relation to the virtualGeometry() of its screen.
\sa frameMargins(), frameGeometry()
*/
QRect QWindow::geometry() const
{
Q_D(const QWindow);
if (d->platformWindow) {
const auto nativeGeometry = d->platformWindow->geometry();
return QHighDpi::fromNativeWindowGeometry(nativeGeometry, this);
}
return d->geometry;
}
/*!
Returns the window frame margins surrounding the window.
\sa geometry(), frameGeometry()
*/
QMargins QWindow::frameMargins() const
{
Q_D(const QWindow);
if (d->platformWindow)
return QHighDpi::fromNativePixels(d->platformWindow->frameMargins(), this);
return QMargins();
}
/*!
Returns the geometry of the window, including its window frame.
The geometry is in relation to the virtualGeometry() of its screen.
\sa geometry(), frameMargins()
*/
QRect QWindow::frameGeometry() const
{
Q_D(const QWindow);
if (d->platformWindow) {
QMargins m = frameMargins();
return QHighDpi::fromNativeWindowGeometry(d->platformWindow->geometry(), this).adjusted(-m.left(), -m.top(), m.right(), m.bottom());
}
return d->geometry;
}
/*!
Returns the top left position of the window, including its window frame.
This returns the same value as frameGeometry().topLeft().
\sa geometry(), frameGeometry()
*/
QPoint QWindow::framePosition() const
{
Q_D(const QWindow);
if (d->platformWindow) {
QMargins margins = frameMargins();
return QHighDpi::fromNativeWindowGeometry(d->platformWindow->geometry().topLeft(), this) - QPoint(margins.left(), margins.top());
}
return d->geometry.topLeft();
}
/*!
Sets the upper left position of the window (\a point) including its window frame.
The position is in relation to the virtualGeometry() of its screen.
\sa setGeometry(), frameGeometry()
*/
void QWindow::setFramePosition(const QPoint &point)
{
Q_D(QWindow);
d->positionPolicy = QWindowPrivate::WindowFrameInclusive;
d->positionAutomatic = false;
if (d->platformWindow) {
d->platformWindow->setGeometry(QHighDpi::toNativeWindowGeometry(QRect(point, size()), this));
} else {
d->geometry.moveTopLeft(point);
}
}
/*!
\brief set the position of the window on the desktop to \a pt
The position is in relation to the virtualGeometry() of its screen.
For interactively moving windows, see startSystemMove(). For interactively
resizing windows, see startSystemResize().
\sa position(), startSystemMove()
*/
void QWindow::setPosition(const QPoint &pt)
{
setGeometry(QRect(pt, size()));
}
/*!
\brief set the position of the window on the desktop to \a posx, \a posy
The position is in relation to the virtualGeometry() of its screen.
\sa position()
*/
void QWindow::setPosition(int posx, int posy)
{
setPosition(QPoint(posx, posy));
}
/*!
\fn QPoint QWindow::position() const
\brief Returns the position of the window on the desktop excluding any window frame
\sa setPosition()
*/
/*!
\fn QSize QWindow::size() const
\brief Returns the size of the window excluding any window frame
\sa resize()
*/
/*!
set the size of the window, excluding any window frame, to a QSize
constructed from width \a w and height \a h
For interactively resizing windows, see startSystemResize().
\sa size(), geometry()
*/
void QWindow::resize(int w, int h)
{
resize(QSize(w, h));
}
/*!
\brief set the size of the window, excluding any window frame, to \a newSize
\sa size(), geometry()
*/
void QWindow::resize(const QSize &newSize)
{
Q_D(QWindow);
d->positionPolicy = QWindowPrivate::WindowFrameExclusive;
if (d->platformWindow) {
d->platformWindow->setGeometry(
QHighDpi::toNativeWindowGeometry(QRect(position(), newSize), this));
} else {
const QSize oldSize = d->geometry.size();
d->geometry.setSize(newSize);
if (newSize.width() != oldSize.width())
emit widthChanged(newSize.width());
if (newSize.height() != oldSize.height())
emit heightChanged(newSize.height());
}
}
/*!
Releases the native platform resources associated with this window.
\sa create()
*/
void QWindow::destroy()
{
Q_D(QWindow);
if (!d->platformWindow)
return;
if (d->platformWindow->isForeignWindow())
return;
d->destroy();
}
void QWindowPrivate::destroy()
{
if (!platformWindow)
return;
Q_Q(QWindow);
QObjectList childrenWindows = q->children();
for (int i = 0; i < childrenWindows.size(); i++) {
QObject *object = childrenWindows.at(i);
if (object->isWindowType()) {
QWindow *w = static_cast<QWindow*>(object);
qt_window_private(w)->destroy();
}
}
bool wasVisible = q->isVisible();
visibilityOnDestroy = wasVisible && platformWindow;
q->setVisible(false);
// Let subclasses act, typically by doing graphics resource cleaup, when
// the window, to which graphics resource may be tied, is going away.
//
// NB! This is dysfunctional when destroy() is invoked from the dtor since
// a reimplemented event() will not get called in the subclasses at that
// stage. However, the typical QWindow cleanup involves either close() or
// going through QWindowContainer, both of which will do an explicit, early
// destroy(), which is good here.
QPlatformSurfaceEvent e(QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed);
QGuiApplication::sendEvent(q, &e);
// Unset platformWindow before deleting, so that the destructor of the
// platform window does not recurse back into the platform window via
// this window during destruction (e.g. as a result of platform events).
delete std::exchange(platformWindow, nullptr);
if (QGuiApplicationPrivate::focus_window == q)
QGuiApplicationPrivate::focus_window = q->parent();
if (QGuiApplicationPrivate::currentMouseWindow == q)
QGuiApplicationPrivate::currentMouseWindow = q->parent();
if (QGuiApplicationPrivate::currentMousePressWindow == q)
QGuiApplicationPrivate::currentMousePressWindow = q->parent();
for (int i = 0; i < QGuiApplicationPrivate::tabletDevicePoints.size(); ++i)
if (QGuiApplicationPrivate::tabletDevicePoints.at(i).target == q)
QGuiApplicationPrivate::tabletDevicePoints[i].target = q->parent();
resizeEventPending = true;
receivedExpose = false;
exposed = false;
}
/*!
Returns the platform window corresponding to the window.
\internal
*/
QPlatformWindow *QWindow::handle() const
{
Q_D(const QWindow);
return d->platformWindow;
}
/*!
Returns the platform surface corresponding to the window.
\internal
*/
QPlatformSurface *QWindow::surfaceHandle() const
{
Q_D(const QWindow);
return d->platformWindow;
}
/*!
Sets whether keyboard grab should be enabled or not (\a grab).
If the return value is true, the window receives all key events until
setKeyboardGrabEnabled(false) is called; other windows get no key events at
all. Mouse events are not affected. Use setMouseGrabEnabled() if you want
to grab that.
\sa setMouseGrabEnabled()
*/
bool QWindow::setKeyboardGrabEnabled(bool grab)
{
Q_D(QWindow);
if (d->platformWindow)
return d->platformWindow->setKeyboardGrabEnabled(grab);
return false;
}
/*!
Sets whether mouse grab should be enabled or not (\a grab).
If the return value is true, the window receives all mouse events until setMouseGrabEnabled(false) is
called; other windows get no mouse events at all. Keyboard events are not affected.
Use setKeyboardGrabEnabled() if you want to grab that.
\sa setKeyboardGrabEnabled()
*/
bool QWindow::setMouseGrabEnabled(bool grab)
{
Q_D(QWindow);
if (d->platformWindow)
return d->platformWindow->setMouseGrabEnabled(grab);
return false;
}
/*!
Returns the screen on which the window is shown, or null if there is none.
For child windows, this returns the screen of the corresponding top level window.
\sa setScreen(), QScreen::virtualSiblings()
*/
QScreen *QWindow::screen() const
{
Q_D(const QWindow);
return d->parentWindow ? d->parentWindow->screen() : d->topLevelScreen.data();
}
/*!
Sets the screen on which the window should be shown.
If the window has been created, it will be recreated on the \a newScreen.
\note If the screen is part of a virtual desktop of multiple screens,
the window will not move automatically to \a newScreen. To place the
window relative to the screen, use the screen's topLeft() position.
This function only works for top level windows.
\sa screen(), QScreen::virtualSiblings()
*/
void QWindow::setScreen(QScreen *newScreen)
{
Q_D(QWindow);
if (!newScreen)
newScreen = QGuiApplication::primaryScreen();
d->setTopLevelScreen(newScreen, newScreen != nullptr);
}
/*!
\fn QWindow::screenChanged(QScreen *screen)
This signal is emitted when a window's \a screen changes, either
by being set explicitly with setScreen(), or automatically when
the window's screen is removed.
*/
/*!
Returns the accessibility interface for the object that the window represents
\internal
\sa QAccessible
*/
QAccessibleInterface *QWindow::accessibleRoot() const
{
return nullptr;
}
/*!
\fn QWindow::focusObjectChanged(QObject *object)
This signal is emitted when the final receiver of events tied to focus
is changed to \a object.
\sa focusObject()
*/
/*!
Returns the QObject that will be the final receiver of events tied focus, such
as key events.
*/
QObject *QWindow::focusObject() const
{
return const_cast<QWindow *>(this);
}
/*!
Shows the window.
This is equivalent to calling showFullScreen(), showMaximized(), or showNormal(),
depending on the platform's default behavior for the window type and flags.
\sa showFullScreen(), showMaximized(), showNormal(), hide(), QStyleHints::showIsFullScreen(), flags()
*/
void QWindow::show()
{
Qt::WindowState defaultState = QGuiApplicationPrivate::platformIntegration()->defaultWindowState(d_func()->windowFlags);
if (defaultState == Qt::WindowFullScreen)
showFullScreen();
else if (defaultState == Qt::WindowMaximized)
showMaximized();
else
showNormal();
}
/*!
Hides the window.
Equivalent to calling setVisible(false).
\sa show(), setVisible()
*/
void QWindow::hide()
{
setVisible(false);
}
/*!
Shows the window as minimized.
Equivalent to calling setWindowStates(Qt::WindowMinimized) and then
setVisible(true).
\sa setWindowStates(), setVisible()
*/
void QWindow::showMinimized()
{
setWindowStates(Qt::WindowMinimized);
setVisible(true);
}
/*!
Shows the window as maximized.
Equivalent to calling setWindowStates(Qt::WindowMaximized) and then
setVisible(true).
\sa setWindowStates(), setVisible()
*/
void QWindow::showMaximized()
{
setWindowStates(Qt::WindowMaximized);
setVisible(true);
}
/*!
Shows the window as fullscreen.
Equivalent to calling setWindowStates(Qt::WindowFullScreen) and then
setVisible(true).
See the \l{QWidget::showFullScreen()} documentation for platform-specific
considerations and limitations.
\sa setWindowStates(), setVisible()
*/
void QWindow::showFullScreen()
{
setWindowStates(Qt::WindowFullScreen);
setVisible(true);
#if !defined Q_OS_QNX // On QNX this window will be activated anyway from libscreen
// activating it here before libscreen activates it causes problems
requestActivate();
#endif
}
/*!
Shows the window as normal, i.e. neither maximized, minimized, nor fullscreen.
Equivalent to calling setWindowStates(Qt::WindowNoState) and then
setVisible(true).
\sa setWindowStates(), setVisible()
*/
void QWindow::showNormal()
{
setWindowStates(Qt::WindowNoState);
setVisible(true);
}
/*!
Close the window.
This closes the window, effectively calling destroy(), and potentially
quitting the application. Returns \c true on success, false if it has a parent
window (in which case the top level window should be closed instead).
\sa destroy(), QGuiApplication::quitOnLastWindowClosed(), closeEvent()
*/
bool QWindow::close()
{
Q_D(QWindow);
if (d->inClose)
return true;
// Do not close non top level windows
if (!isTopLevel())
return false;
if (!d->platformWindow)
return true;
// The window might be deleted during close,
// as a result of delivering the close event.
QPointer guard(this);
d->inClose = true;
bool success = d->platformWindow->close();
if (guard)
d->inClose = false;
return success;
}
bool QWindowPrivate::participatesInLastWindowClosed() const
{
Q_Q(const QWindow);
if (!q->isTopLevel())
return false;
// Tool-tip widgets do not normally have Qt::WA_QuitOnClose,
// but since we do not have a similar flag for non-widget
// windows we need an explicit exclusion here as well.
if (q->type() == Qt::ToolTip)
return false;
// A window with a transient parent is not a primary window,
// it's a secondary window.
if (q->transientParent())
return false;
return true;
}
bool QWindowPrivate::treatAsVisible() const
{
Q_Q(const QWindow);
return q->isVisible();
}
/*!
The expose event (\a ev) is sent by the window system when a window moves
between the un-exposed and exposed states.
An exposed window is potentially visible to the user. If the window is moved
off screen, is made totally obscured by another window, is minimized, or
similar, this function might be called and the value of isExposed() might
change to false. You may use this event to limit expensive operations such
as animations to only run when the window is exposed.
This event should not be used to paint. To handle painting implement
paintEvent() instead.
A resize event will always be sent before the expose event the first time
a window is shown.
\sa paintEvent(), isExposed()
*/
void QWindow::exposeEvent(QExposeEvent *ev)
{
ev->ignore();
}
/*!
The paint event (\a ev) is sent by the window system whenever an area of
the window needs a repaint, for example when initially showing the window,
or due to parts of the window being uncovered by moving another window.
The application is expected to render into the window in response to the
paint event, regardless of the exposed state of the window. For example,
a paint event may be sent before the window is exposed, to prepare it for
showing to the user.
\since 6.0
\sa exposeEvent()
*/
void QWindow::paintEvent(QPaintEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle window move events (\a ev).
*/
void QWindow::moveEvent(QMoveEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle resize events (\a ev).
The resize event is called whenever the window is resized in the windowing system,
either directly through the windowing system acknowledging a setGeometry() or resize() request,
or indirectly through the user resizing the window manually.
*/
void QWindow::resizeEvent(QResizeEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle show events (\a ev).
The function is called when the window has requested becoming visible.
If the window is successfully shown by the windowing system, this will
be followed by a resize and an expose event.
*/
void QWindow::showEvent(QShowEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle hide events (\a ev).
The function is called when the window has requested being hidden in the
windowing system.
*/
void QWindow::hideEvent(QHideEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle close events (\a ev).
The function is called when the window is requested to close. Call \l{QEvent::ignore()}
on the event if you want to prevent the window from being closed.
\sa close()
*/
void QWindow::closeEvent(QCloseEvent *ev)
{
Q_UNUSED(ev);
}
/*!
Override this to handle any event (\a ev) sent to the window.
Return \c true if the event was recognized and processed.
Remember to call the base class version if you wish for mouse events,
key events, resize events, etc to be dispatched as usual.
*/
bool QWindow::event(QEvent *ev)
{
switch (ev->type()) {
case QEvent::MouseMove:
mouseMoveEvent(static_cast<QMouseEvent*>(ev));
break;
case QEvent::MouseButtonPress:
mousePressEvent(static_cast<QMouseEvent*>(ev));
break;
case QEvent::MouseButtonRelease:
mouseReleaseEvent(static_cast<QMouseEvent*>(ev));
break;
case QEvent::MouseButtonDblClick:
mouseDoubleClickEvent(static_cast<QMouseEvent*>(ev));
break;
case QEvent::TouchBegin:
case QEvent::TouchUpdate:
case QEvent::TouchEnd:
case QEvent::TouchCancel:
touchEvent(static_cast<QTouchEvent *>(ev));
break;
case QEvent::Move:
moveEvent(static_cast<QMoveEvent*>(ev));
break;
case QEvent::Resize:
resizeEvent(static_cast<QResizeEvent*>(ev));
break;
case QEvent::KeyPress:
keyPressEvent(static_cast<QKeyEvent *>(ev));
break;
case QEvent::KeyRelease:
keyReleaseEvent(static_cast<QKeyEvent *>(ev));
break;
case QEvent::FocusIn: {
focusInEvent(static_cast<QFocusEvent *>(ev));
#ifndef QT_NO_ACCESSIBILITY
QAccessible::State state;
state.active = true;
QAccessibleStateChangeEvent event(this, state);
QAccessible::updateAccessibility(&event);
#endif
break; }
case QEvent::FocusOut: {
focusOutEvent(static_cast<QFocusEvent *>(ev));
#ifndef QT_NO_ACCESSIBILITY
QAccessible::State state;
state.active = true;
QAccessibleStateChangeEvent event(this, state);
QAccessible::updateAccessibility(&event);
#endif
break; }
#if QT_CONFIG(wheelevent)
case QEvent::Wheel:
wheelEvent(static_cast<QWheelEvent*>(ev));
break;
#endif
case QEvent::Close: {
Q_D(QWindow);
const bool wasVisible = d->treatAsVisible();
const bool participatesInLastWindowClosed = d->participatesInLastWindowClosed();
// The window might be deleted in the close event handler
QPointer<QWindow> deletionGuard(this);
closeEvent(static_cast<QCloseEvent*>(ev));
if (ev->isAccepted()) {
if (deletionGuard)
destroy();
if (wasVisible && participatesInLastWindowClosed)
QGuiApplicationPrivate::instance()->maybeLastWindowClosed();
}
break;
}
case QEvent::Expose:
exposeEvent(static_cast<QExposeEvent *>(ev));
break;
case QEvent::Paint:
paintEvent(static_cast<QPaintEvent *>(ev));
break;
case QEvent::Show:
showEvent(static_cast<QShowEvent *>(ev));
break;
case QEvent::Hide:
hideEvent(static_cast<QHideEvent *>(ev));
break;
case QEvent::ApplicationWindowIconChange:
setIcon(icon());
break;
case QEvent::WindowStateChange: {
Q_D(QWindow);
emit windowStateChanged(QWindowPrivate::effectiveState(d->windowState));
d->updateVisibility();
break;
}
#if QT_CONFIG(tabletevent)
case QEvent::TabletPress:
case QEvent::TabletMove:
case QEvent::TabletRelease:
tabletEvent(static_cast<QTabletEvent *>(ev));
break;
#endif
case QEvent::PlatformSurface: {
if ((static_cast<QPlatformSurfaceEvent *>(ev))->surfaceEventType() == QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed) {
#ifndef QT_NO_OPENGL
QOpenGLContext *context = QOpenGLContext::currentContext();
if (context && context->surface() == static_cast<QSurface *>(this))
context->doneCurrent();
#endif
}
break;
}
default:
return QObject::event(ev);
}
#ifndef QT_NO_CONTEXTMENU
/*
QGuiApplicationPrivate::processContextMenuEvent blocks mouse-triggered
context menu events that the QPA plugin might generate. In practice that
never happens, as even on Windows WM_CONTEXTMENU is never generated by
the OS (we never call the default window procedure that would do that in
response to unhandled WM_RBUTTONUP).
So, we always have to syntheize QContextMenuEvent for mouse events anyway.
QWidgetWindow synthesizes QContextMenuEvent similar to this code, and
never calls QWindow::event, so we have to do it here as well.
This logic could be simplified by always synthesizing events in
QGuiApplicationPrivate, or perhaps even in each QPA plugin. See QTBUG-93486.
*/
static const QEvent::Type contextMenuTrigger =
QGuiApplicationPrivate::platformTheme()->themeHint(QPlatformTheme::ContextMenuOnMouseRelease).toBool() ?
QEvent::MouseButtonRelease : QEvent::MouseButtonPress;
auto asMouseEvent = [](QEvent *ev) {
const auto t = ev->type();
return t == QEvent::MouseButtonPress || t == QEvent::MouseButtonRelease
? static_cast<QMouseEvent *>(ev) : nullptr ;
};
if (QMouseEvent *me = asMouseEvent(ev); me &&
ev->type() == contextMenuTrigger && me->button() == Qt::RightButton) {
QContextMenuEvent e(QContextMenuEvent::Mouse, me->position().toPoint(),
me->globalPosition().toPoint(), me->modifiers());
QGuiApplication::sendEvent(this, &e);
}
#endif
return true;
}
/*!
Schedules a QEvent::UpdateRequest event to be delivered to this window.
The event is delivered in sync with the display vsync on platforms
where this is possible. Otherwise, the event is delivered after a
delay of 5 ms. The additional time is there to give the event loop
a bit of idle time to gather system events, and can be overridden
using the QT_QPA_UPDATE_IDLE_TIME environment variable.
When driving animations, this function should be called once after drawing
has completed. Calling this function multiple times will result in a single
event being delivered to the window.
Subclasses of QWindow should reimplement event(), intercept the event and
call the application's rendering code, then call the base class
implementation.
\note The subclass' reimplementation of event() must invoke the base class
implementation, unless it is absolutely sure that the event does not need to
be handled by the base class. For example, the default implementation of
this function relies on QEvent::Timer events. Filtering them away would
therefore break the delivery of the update events.
\since 5.5
*/
void QWindow::requestUpdate()
{
Q_ASSERT_X(QThread::currentThread() == QCoreApplication::instance()->thread(),
"QWindow", "Updates can only be scheduled from the GUI (main) thread");
Q_D(QWindow);
if (d->updateRequestPending || !d->platformWindow)
return;
d->updateRequestPending = true;
d->platformWindow->requestUpdate();
}
/*!
Override this to handle key press events (\a ev).
\sa keyReleaseEvent()
*/
void QWindow::keyPressEvent(QKeyEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle key release events (\a ev).
\sa keyPressEvent()
*/
void QWindow::keyReleaseEvent(QKeyEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle focus in events (\a ev).
Focus in events are sent when the window receives keyboard focus.
\sa focusOutEvent()
*/
void QWindow::focusInEvent(QFocusEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle focus out events (\a ev).
Focus out events are sent when the window loses keyboard focus.
\sa focusInEvent()
*/
void QWindow::focusOutEvent(QFocusEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle mouse press events (\a ev).
\sa mouseReleaseEvent()
*/
void QWindow::mousePressEvent(QMouseEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle mouse release events (\a ev).
\sa mousePressEvent()
*/
void QWindow::mouseReleaseEvent(QMouseEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle mouse double click events (\a ev).
\sa mousePressEvent(), QStyleHints::mouseDoubleClickInterval()
*/
void QWindow::mouseDoubleClickEvent(QMouseEvent *ev)
{
ev->ignore();
}
/*!
Override this to handle mouse move events (\a ev).
*/
void QWindow::mouseMoveEvent(QMouseEvent *ev)
{
ev->ignore();
}
#if QT_CONFIG(wheelevent)
/*!
Override this to handle mouse wheel or other wheel events (\a ev).
*/
void QWindow::wheelEvent(QWheelEvent *ev)
{
ev->ignore();
}
#endif // QT_CONFIG(wheelevent)
/*!
Override this to handle touch events (\a ev).
*/
void QWindow::touchEvent(QTouchEvent *ev)
{
ev->ignore();
}
#if QT_CONFIG(tabletevent)
/*!
Override this to handle tablet press, move, and release events (\a ev).
Proximity enter and leave events are not sent to windows, they are
delivered to the application instance.
*/
void QWindow::tabletEvent(QTabletEvent *ev)
{
ev->ignore();
}
#endif
/*!
Override this to handle platform dependent events.
Will be given \a eventType, \a message and \a result.
This might make your application non-portable.
Should return true only if the event was handled.
*/
bool QWindow::nativeEvent(const QByteArray &eventType, void *message, qintptr *result)
{
Q_UNUSED(eventType);
Q_UNUSED(message);
Q_UNUSED(result);
return false;
}
/*!
\fn QPointF QWindow::mapToGlobal(const QPointF &pos) const
Translates the window coordinate \a pos to global screen
coordinates. For example, \c{mapToGlobal(QPointF(0,0))} would give
the global coordinates of the top-left pixel of the window.
\sa mapFromGlobal()
\since 6.0
*/
QPointF QWindow::mapToGlobal(const QPointF &pos) const
{
Q_D(const QWindow);
// QTBUG-43252, prefer platform implementation for foreign windows.
if (d->platformWindow
&& (d->platformWindow->isForeignWindow() || d->platformWindow->isEmbedded())) {
return QHighDpi::fromNativeGlobalPosition(d->platformWindow->mapToGlobalF(QHighDpi::toNativeLocalPosition(pos, this)), this);
}
if (!QHighDpiScaling::isActive())
return pos + d->globalPosition();
// The normal pos + windowGlobalPos calculation may give a point which is outside
// screen geometry for windows which span multiple screens, due to the way QHighDpiScaling
// creates gaps between screens in the the device indendent cooordinate system.
//
// Map the position (and the window's global position) to native coordinates, perform
// the addition, and then map back to device independent coordinates.
QPointF nativeLocalPos = QHighDpi::toNativeLocalPosition(pos, this);
QPointF nativeWindowGlobalPos = QHighDpi::toNativeGlobalPosition(QPointF(d->globalPosition()), this);
QPointF nativeGlobalPos = nativeLocalPos + nativeWindowGlobalPos;
QPointF deviceIndependentGlobalPos = QHighDpi::fromNativeGlobalPosition(nativeGlobalPos, this);
return deviceIndependentGlobalPos;
}
/*!
\overload
*/
QPoint QWindow::mapToGlobal(const QPoint &pos) const
{
return mapToGlobal(QPointF(pos)).toPoint();
}
/*!
\fn QPointF QWindow::mapFromGlobal(const QPointF &pos) const
Translates the global screen coordinate \a pos to window
coordinates.
\sa mapToGlobal()
\since 6.0
*/
QPointF QWindow::mapFromGlobal(const QPointF &pos) const
{
Q_D(const QWindow);
// QTBUG-43252, prefer platform implementation for foreign windows.
if (d->platformWindow
&& (d->platformWindow->isForeignWindow() || d->platformWindow->isEmbedded())) {
return QHighDpi::fromNativeLocalPosition(d->platformWindow->mapFromGlobalF(QHighDpi::toNativeGlobalPosition(pos, this)), this);
}
if (!QHighDpiScaling::isActive())
return pos - d->globalPosition();
// Calculate local position in the native coordinate system. (See comment for the
// corresponding mapToGlobal() code above).
QPointF nativeGlobalPos = QHighDpi::toNativeGlobalPosition(pos, this);
QPointF nativeWindowGlobalPos = QHighDpi::toNativeGlobalPosition(QPointF(d->globalPosition()), this);
QPointF nativeLocalPos = nativeGlobalPos - nativeWindowGlobalPos;
QPointF deviceIndependentLocalPos = QHighDpi::fromNativeLocalPosition(nativeLocalPos, this);
return deviceIndependentLocalPos;
}
/*!
\overload
*/
QPoint QWindow::mapFromGlobal(const QPoint &pos) const
{
return QWindow::mapFromGlobal(QPointF(pos)).toPoint();
}
QPoint QWindowPrivate::globalPosition() const
{
Q_Q(const QWindow);
QPoint offset = q->position();
for (const QWindow *p = q->parent(); p; p = p->parent()) {
QPlatformWindow *pw = p->handle();
if (pw && (pw->isForeignWindow() || pw->isEmbedded())) {
// Use mapToGlobal() for foreign windows
offset += p->mapToGlobal(QPoint(0, 0));
break;
} else {
offset += p->position();
}
}
return offset;
}
Q_GUI_EXPORT QWindowPrivate *qt_window_private(QWindow *window)
{
return window->d_func();
}
QWindow *QWindowPrivate::topLevelWindow(QWindow::AncestorMode mode) const
{
Q_Q(const QWindow);
QWindow *window = const_cast<QWindow *>(q);
while (window) {
QWindow *parent = window->parent(mode);
if (!parent)
break;
window = parent;
}
return window;
}
/*!
Creates a local representation of a window created by another process or by
using native libraries below Qt.
Given the handle \a id to a native window, this method creates a QWindow
object which can be used to represent the window when invoking methods like
setParent() and setTransientParent().
This can be used, on platforms which support it, to embed a QWindow inside a
native window, or to embed a native window inside a QWindow.
If foreign windows are not supported or embedding the native window
failed in the platform plugin, this function returns \nullptr.
\note The resulting QWindow should not be used to manipulate the underlying
native window (besides re-parenting), or to observe state changes of the
native window. Any support for these kind of operations is incidental, highly
platform dependent and untested.
\sa setParent()
*/
QWindow *QWindow::fromWinId(WId id)
{
if (!QGuiApplicationPrivate::platformIntegration()->hasCapability(QPlatformIntegration::ForeignWindows)) {
qWarning("QWindow::fromWinId(): platform plugin does not support foreign windows.");
return nullptr;
}
QWindow *window = new QWindow;
qt_window_private(window)->create(false, id);
if (!window->handle()) {
delete window;
return nullptr;
}
return window;
}
/*!
Causes an alert to be shown for \a msec milliseconds. If \a msec is \c 0 (the
default), then the alert is shown indefinitely until the window becomes
active again. This function has no effect on an active window.
In alert state, the window indicates that it demands attention, for example by
flashing or bouncing the taskbar entry.
\since 5.1
*/
void QWindow::alert(int msec)
{
Q_D(QWindow);
if (!d->platformWindow || d->platformWindow->isAlertState() || isActive())
return;
d->platformWindow->setAlertState(true);
if (d->platformWindow->isAlertState() && msec)
QTimer::singleShot(msec, this, SLOT(_q_clearAlert()));
}
void QWindowPrivate::_q_clearAlert()
{
if (platformWindow && platformWindow->isAlertState())
platformWindow->setAlertState(false);
}
#ifndef QT_NO_CURSOR
/*!
\brief set the cursor shape for this window
The mouse \a cursor will assume this shape when it is over this
window, unless an override cursor is set.
See the \l{Qt::CursorShape}{list of predefined cursor objects} for a
range of useful shapes.
If no cursor has been set, or after a call to unsetCursor(), the
parent window's cursor is used.
By default, the cursor has the Qt::ArrowCursor shape.
Some underlying window implementations will reset the cursor if it
leaves a window even if the mouse is grabbed. If you want to have
a cursor set for all windows, even when outside the window, consider
QGuiApplication::setOverrideCursor().
\sa QGuiApplication::setOverrideCursor()
*/
void QWindow::setCursor(const QCursor &cursor)
{
Q_D(QWindow);
d->setCursor(&cursor);
}
/*!
\brief Restores the default arrow cursor for this window.
*/
void QWindow::unsetCursor()
{
Q_D(QWindow);
d->setCursor(nullptr);
}
/*!
\brief the cursor shape for this window
\sa setCursor(), unsetCursor()
*/
QCursor QWindow::cursor() const
{
Q_D(const QWindow);
return d->cursor;
}
void QWindowPrivate::setCursor(const QCursor *newCursor)
{
Q_Q(QWindow);
if (newCursor) {
const Qt::CursorShape newShape = newCursor->shape();
if (newShape <= Qt::LastCursor && hasCursor && newShape == cursor.shape())
return; // Unchanged and no bitmap/custom cursor.
cursor = *newCursor;
hasCursor = true;
} else {
if (!hasCursor)
return;
cursor = QCursor(Qt::ArrowCursor);
hasCursor = false;
}
// Only attempt to emit signal if there is an actual platform cursor
if (applyCursor()) {
QEvent event(QEvent::CursorChange);
QGuiApplication::sendEvent(q, &event);
}
}
// Apply the cursor and returns true iff the platform cursor exists
bool QWindowPrivate::applyCursor()
{
Q_Q(QWindow);
if (QScreen *screen = q->screen()) {
if (QPlatformCursor *platformCursor = screen->handle()->cursor()) {
if (!platformWindow)
return true;
QCursor *c = QGuiApplication::overrideCursor();
if (c != nullptr && platformCursor->capabilities().testFlag(QPlatformCursor::OverrideCursor))
return true;
if (!c && hasCursor)
c = &cursor;
platformCursor->changeCursor(c, q);
return true;
}
}
return false;
}
#endif // QT_NO_CURSOR
void *QWindow::resolveInterface(const char *name, int revision) const
{
using namespace QNativeInterface::Private;
auto *platformWindow = handle();
Q_UNUSED(platformWindow);
Q_UNUSED(name);
Q_UNUSED(revision);
#if defined(Q_OS_WIN)
QT_NATIVE_INTERFACE_RETURN_IF(QWindowsWindow, platformWindow);
#endif
#if QT_CONFIG(xcb)
QT_NATIVE_INTERFACE_RETURN_IF(QXcbWindow, platformWindow);
#endif
#if defined(Q_OS_MACOS)
QT_NATIVE_INTERFACE_RETURN_IF(QCocoaWindow, platformWindow);
#endif
return nullptr;
}
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug debug, const QWindow *window)
{
QDebugStateSaver saver(debug);
debug.nospace();
if (window) {
debug << window->metaObject()->className() << '(' << (const void *)window;
if (!window->objectName().isEmpty())
debug << ", name=" << window->objectName();
if (debug.verbosity() > 2) {
const QRect geometry = window->geometry();
if (window->isVisible())
debug << ", visible";
if (window->isExposed())
debug << ", exposed";
debug << ", state=" << window->windowState()
<< ", type=" << window->type() << ", flags=" << window->flags()
<< ", surface type=" << window->surfaceType();
if (window->isTopLevel())
debug << ", toplevel";
debug << ", " << geometry.width() << 'x' << geometry.height()
<< Qt::forcesign << geometry.x() << geometry.y() << Qt::noforcesign;
const QMargins margins = window->frameMargins();
if (!margins.isNull())
debug << ", margins=" << margins;
debug << ", devicePixelRatio=" << window->devicePixelRatio();
if (const QPlatformWindow *platformWindow = window->handle())
debug << ", winId=0x" << Qt::hex << platformWindow->winId() << Qt::dec;
if (const QScreen *screen = window->screen())
debug << ", on " << screen->name();
}
debug << ')';
} else {
debug << "QWindow(0x0)";
}
return debug;
}
#endif // !QT_NO_DEBUG_STREAM
#if QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC)
/*!
Associates this window with the specified Vulkan \a instance.
\a instance must stay valid as long as this QWindow instance exists.
*/
void QWindow::setVulkanInstance(QVulkanInstance *instance)
{
Q_D(QWindow);
d->vulkanInstance = instance;
}
/*!
\return the associated Vulkan instance if any was set, otherwise \nullptr.
*/
QVulkanInstance *QWindow::vulkanInstance() const
{
Q_D(const QWindow);
return d->vulkanInstance;
}
#endif // QT_CONFIG(vulkan)
QT_END_NAMESPACE
#include "moc_qwindow.cpp"
|