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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-coding-navigating.html
\page creator-highlighting.html
\nextpage creator-checking-code-syntax.html
\title Semantic Highlighting
\QC understands the C++, QML, and JavaScript languages as code, not as plain
text. It reads the source code, analyzes it, and highlights it based on the
semantic checks that it does for the following code elements:
\list
\li Types (such as classes, structs, and type definitions)
\li Local variables
\li Class fields
\li Virtual functions
\endlist
To specify the color scheme to use for semantic highlighting, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol {Fonts & Color}.
\QC supports syntax highlighting also for other types of files than C++,
QML, or JavaScript.
\section1 Generic Highlighting
Generic highlighting is based on highlight definition files that are
provided by the
\l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/}
{Kate Editor}. You can download highlight definition files for use with \QC.
For more information about the definition files, see
\l{http://kde-files.org/index.php?xcontentmode=680}{KDE-Files.org}.
If you have a Unix installation that comes with the Kate Editor, you might
already have the definition files installed. Typically, the files are
located in a read-only directory, and therefore, you cannot manage them. \QC
can try to locate them and use them as fallback files, when the primary
location does not contain the definition for the current file type. You can
also specify the directory that contains preinstalled highlight
definition files as the primary location.
When you open a file for editing and the editor cannot find the highlight
definition for it, an alert appears. To suppress the alerts, you can specify
patterns for ignoring files.
To download highlight definition files:
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Text Editor} > \uicontrol {Generic Highlighter}.
\image qtcreator-generic-highlighter.png "Generic Highlighter options"
\li In the \uicontrol Location field, specify the path to the primary
location for highlight definition files.
\li Click \uicontrol {Download Definitions} to open a list of highlight
definition files available for download.
\image qtcreator-manage-definitions.png "Download Definitions dialog"
\li Select highlight definition files in the list and click
\uicontrol {Download Selected Definitions}.
\li Select the \uicontrol {Use fallback location} check box to specify the
secondary location where the editor will look for highlight
definition files.
\li Click \uicontrol Autodetect to allow \QC to look for highlight
definition files on your system, or click \uicontrol Browse to locate
them in the file system yourself.
\li In the \uicontrol {Ignored file patterns} field, specify file patterns to
suppress alerts if the highlight definitions for the
specified files are not found.
\li Click \uicontrol OK to save your changes.
\endlist
\section1 Highlighting and Folding Blocks
Use block highlighting to visually separate parts of the code that belong
together. For example, when you place the cursor within the braces, the code
enclosed in braces is highlighted.
\image qtcreator-blockhighlighting.png
To enable block highlighting, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol Display >
\uicontrol {Highlight blocks}.
Use the folding markers to collapse and expand blocks of code within braces.
Click the folding marker to collapse or expand a block. In the figure above,
the folding markers are located between the line number and the text pane.
To show the folding markers, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Text Editor} > \uicontrol Display >
\uicontrol {Display folding markers}. This option is enabled by default.
When the cursor is on a brace, the matching brace is animated by default. To
turn off the animation and just highlight the block and the braces, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol Display and deselect \uicontrol {Animate matching parentheses}.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-highlighting.html
\page creator-checking-code-syntax.html
\nextpage creator-completing-code.html
\title Checking Code Syntax
As you write code, \QC checks code syntax. When \QC spots a syntax error in
your code it underlines it and shows error details when you move the mouse
pointer over the error. Similarly, when you are working on an instance of a
JavaScript object notation (JSON) entity, \QC underlines errors in JSON data
structure.
\list
\li Syntax errors are underlined in red.
In the following figure, a semicolon is missing at the end of the
line.
\image qtcreator-syntaxerror.png
\li Semantic errors and warnings are underlined in olive.
In the following figure, the variable is not used.
\image qtcreator-semanticerror.png
\endlist
In addition, you can run static checks on the QML and JavaScript code in
your project to find common problems.
\section1 Checking JSON Data Structure
\QC validates instances of JSON entities against
\l{http://tools.ietf.org/html/draft-zyp-json-schema-03}
{A JSON Media Type for Describing the Structure and Meaning of JSON Documents}.
However, \QC does not understand the entire specification.
A JSON schema defines the structure of JSON data. It determines what JSON
data is required for an application and how to interact with it.
The specification does not define how to map JSON instances with JSON
schemas. \QC looks for a JSON schema file with a
name that matches the name of the JSON instance file in the user
configuration folder. For example, \c {~/config/QtProject/qtcreator/json} on
Linux and \macos and
\c {C:\Users\username\AppData\Roaming\QtCreator\qtcreator\json}
in Windows. To check JSON data structure, copy the JSON schema file to the
above folder.
\section1 Checking JavaScript and QML Syntax
To run the checks, select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Run Checks} or press \key {Ctrl+Shift+C}. The results are shown
in the \uicontrol {QML Analysis} filter of the \uicontrol Issues output
pane.
\section1 List of JavaScript and QML Checks
Many of the JavaScript checks are similar to the ones in Douglas Crockford's
\l{http://www.jslint.com}{JSLint} tool.
\table
\header
\li Id
\li Severity
\li Message
\li Description
\row
\li M1
\li Error
\li Invalid value for enum
\li
\row
\li M2
\li Error
\li Enum value must be a string or a number
\li
\row
\li M3
\li Error
\li Number value expected
\li
\row
\li M4
\li Error
\li Boolean value expected
\li
\row
\li M5
\li Error
\li String value expected
\li
\row
\li M6
\li Error
\li Invalid URL
\li
\row
\li M7
\li Warning
\li File or directory does not exist
\li
\row
\li M8
\li Error
\li Invalid color
\li
\row
\li M9
\li Error
\li Anchor line expected
\li
\row
\li M10
\li Error
\li Duplicate property binding
\li
\row
\li M11
\li Error
\li Id expected
\li
\row
\li M14
\li Error
\li Invalid id
\li
\row
\li M15
\li Error
\li Duplicate id
\li Ids in a file must be unique.
\row
\li M16
\li Error
\li Invalid property name \c name
\li
\row
\li M17
\li Error
\li \c Name does not have members
\li
\row
\li M18
\li Error
\li \c Field is not a member of \c object
\li
\row
\li M19
\li Warning
\li Assignment in condition
\li It could be a typing error. If it is intentional, wrap the
assignment in parentheses.
\row
\li M20
\li Warning
\li Unterminated non-empty case block
\li Case blocks should either be empty or end in a flow control
statement such as \c break, \c return or \c continue.
Alternatively you can indicate intentional fall through by ending
with a \c {// fall through} comment.
\row
\li M23
\li Warning
\li Do not use \c eval
\li
\row
\li M28
\li Warning
\li Unreachable
\li Indicates that the underlined statement will never be executed.
\row
\li M29
\li Warning
\li Do not use \c with
\li
\row
\li M30
\li Warning
\li Do not use comma expressions
\li
\row
\li M31
\li Warning
\li Unnecessary message suppression
\li
\row
\li M103
\li Warning
\li \c Name is already a formal parameter
\li
\row
\li M104
\li Warning
\li \c Name is already a function
\li
\row
\li M105
\li Warning
\li Var \c name is used before its declaration
\li
\row
\li M106
\li Warning
\li \c Name is already a var
\li
\row
\li M107
\li Warning
\li \c Name is declared more than once
\li Variables declared in a function are always visible everywhere in
the function, even when declared in nested blocks or \c for
statement conditions. Redeclaring a variable has no effect.
\row
\li M108
\li Warning
\li Function \c name is used before its declaration
\li
\row
\li M109
\li Warning
\li Do not use \c Boolean as a constructor
\li
\row
\li M110
\li Warning
\li Do not use \c String as a constructor
\li
\row
\li M111
\li Warning
\li Do not use \c Object as a constructor
\li
\row
\li M112
\li Warning
\li Do not use \c Array as a constructor
\li
\row
\li M113
\li Warning
\li Do not use \c Function as a constructor
\li
\row
\li M114
\li Hint
\li The \c function keyword and the opening parenthesis should be
separated by a single space
\li
\row
\li M115
\li Warning
\li Do not use stand-alone blocks
\li Blocks do not affect variable scoping. Thus blocks that are not
associated to \c if, \c while, etc. have no effect and should be
avoided.
\row
\li M116
\li Warning
\li Do not use void expressions
\li
\row
\li M117
\li Warning
\li Confusing pluses
\li
\row
\li M119
\li Warning
\li Confusing minuses
\li
\row
\li M121
\li Hint
\li Declare all function vars on a single line
\li
\row
\li M123
\li Hint
\li Unnecessary parentheses
\li
\target m126
\row
\li M126
\li Warning
\li \c == and \c != may perform type coercion, use \c === or \c !== to
avoid it
\li The non-strict equality comparison is allowed to convert its
arguments to a common type. That can lead to unexpected results such
as \c {' \t\r\n' == 0} being true. Use the strict equality operators
\c === and \c !== and be explicit about conversions you require.
\row
\li M127
\li Warning
\li Expression statements should be assignments, calls or delete
expressions only
\li
\row
\li M128
\li Error
\li A state cannot have the specified child item
\li
\row
\li M201
\li Hint
\li Place var declarations at the start of a function
\li
\row
\li M202
\li Hint
\li Use only one statement per line
\li
\row
\li M203
\li Warning
\li Imperative code is not supported in the Qt Quick Designer
\li
\row
\li M204
\li Warning
\li This QML type is not supported in the Qt Quick Designer
\li
\row
\li M205
\li Warning
\li Reference to parent QML type cannot be resolved correctly by the Qt
Quick Designer
\li
\row
\li M206
\li Warning
\li This visual property binding cannot be evaluated in the local
context and might not show up in Qt Quick Designer as expected
\li
\row
\li M207
\li Warning
\li Qt Quick Designer only supports states in the root QML type
\li
\row
\li M208
\li Error
\li This type (type name) is not supported as a root element by \QMLD.
\li
\row
\li M220
\li Error
\li This type (type name) is not supported as a root element of a Qt
Quick UI form.
\li
\row
\li M221
\li Error
\li This type (type name) is not supported in a Qt Quick UI form.
\li
\row
\li M222
\li Error
\li Functions are not supported in a Qt Quick UI form.
\li
\row
\li M223
\li Error
\li Java Script blocks are not supported in a Qt Quick UI form.
\li
\row
\li M224
\li Error
\li Behavior type is not supported in a Qt Quick UI form.
\li
\row
\li M225
\li Error
\li States are only supported in the root item in a Qt Quick UI form.
\li
\row
\li M226
\li Error
\li Referencing the parent of the root item is not supported in a Qt
Quick UI form.
\li
\row
\li M300
\li Error
\li Unknown component
\li
\row
\li M301
\li Error
\li Could not resolve the prototype \c name of \c object
\li
\row
\li M302
\li Error
\li Could not resolve the prototype \c name
\li
\row
\li M303
\li Error
\li Prototype cycle, the last non-repeated component is \c name
\li
\row
\li M304
\li Error
\li Invalid property type \c name
\li
\row
\li M305
\li Warning
\li \c == and \c != perform type coercion, use \c === or \c !== to
avoid it
\li See \l{m126}{M126}.
\row
\li M306
\li Warning
\li Calls of functions that start with an uppercase letter should use
\c new
\li By convention, functions that start with an uppercase letter
are constructor functions that should only be used with \c new.
\row
\li M307
\li Warning
\li Use \c new only with functions that start with an uppercase letter
\li
\row
\li M308
\li Warning
\li Do not use \c Number as a constructor
\li
\row
\li M309
\li Hint
\li Use spaces around binary operators
\li
\row
\li M310
\li Warning
\li Unintentional empty block, use ({}) for empty object literal
\li
\row
\li M311
\li Hint
\li Use \c type instead of \c var or \c variant to improve performance
\li
\row
\li M312
\li Error
\li Missing property \c number
\li
\row
\li M313
\li Error
\li Object value expected
\li
\row
\li M314
\li Error
\li Array value expected
\li
\row
\li M315
\li Error
\li \c Value value expected
\li
\row
\li M316
\li Error
\li Maximum number value is \c number
\li
\row
\li M317
\li Error
\li Minimum number value is \c number
\li
\row
\li M318
\li Error
\li Maximum number value is exclusive
\li
\row
\li M319
\li Error
\li Minimum number value is exclusive
\li
\row
\li M320
\li Error
\li String value does not match required pattern
\li
\row
\li M321
\li Error
\li Minimum string value length is \c number
\li
\row
\li M322
\li Error
\li Maximum string value length is \c number
\li
\row
\li M323
\li Error
\li \c Number elements expected in array value
\li
\row
\li M324
\li Warning
\li Using Qt Quick 1 code model instead of Qt Quick 2
\li The code model might be corrupt or the QML emulation layer might
have been built with a different Qt version than the one selected in
the build and run kit. For more information, see
\l {Resetting the Code Model} and
\l {Running QML Modules in Qt Quick Designer}.
\endtable
\section1 Resetting the Code Model
If you change the build and run kit when you have QML files open in the code
editor, the code model might become corrupt. The following error message
indicates that this might have happened: \e{Using Qt Quick 1 code model
instead of Qt Quick 2}.
You can see the error message when you move the mouse pointer over code that
\QC underlines in the code editor or when you open a QML file in the
\uicontrol Design mode.
To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Reset Code Model}.
If this does not help, try changing the QML emulation layer to the one that
was built with the same Qt version as the one selected in the build and run
kit. For more information, see \l{Running QML Modules in Qt Quick Designer}.
\section1 Inspecting QML and JavaScript
To inspect QML and JavaScript properties, methods, and enums, move the
cursor over them and select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Inspect API for Element Under Cursor}.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-checking-code-syntax.html
\page creator-completing-code.html
\nextpage creator-indenting-code.html
\title Completing Code
As you write code, \QC suggests properties, IDs, and code snippets to
complete the code. It provides a list of context-sensitive suggestions to
the statement currently under your cursor. Press \key Tab
or \key Enter to accept the selected suggestion and complete the code.
\image qtcreator-codecompletion.png
To open the list of suggestions at any time, press \key {Ctrl+Space}.
If only one option is available, \QC inserts it automatically.
When completion is invoked manually, \QC completes the common prefix of the
list of suggestions. This is especially useful for classes with several
similarly named members. To disable this functionality, uncheck
\uicontrol {Autocomplete common prefix} in the code completion preferences.
Select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor}
> \uicontrol Completion.
By default, code completion does not consider case. To apply full or
first-letter case-sensitivity, select \uicontrol Full or
\uicontrol {First Letter} in the \uicontrol {Case-sensitivity} field.
\section2 Summary of Available Types
The following table lists available types for code completion and icon used
for each.
\table
\header
\li Icon
\li Description
\row
\li \inlineimage completion/class.png
\li A class
\row
\li \inlineimage completion/enum.png
\li An enum
\row
\li \inlineimage completion/enumerator.png
\li An enumerator (value of an enum)
\row
\li \inlineimage completion/func.png
\li A function
\row
\li \inlineimage completion/func_priv.png
\li A private function
\row
\li \inlineimage completion/func_prot.png
\li A protected function
\row
\li \inlineimage completion/var.png
\li A variable
\row
\li \inlineimage completion/var_priv.png
\li A private variable
\row
\li \inlineimage completion/var_prot.png
\li A protected variable
\row
\li \inlineimage completion/signal.png
\li A signal
\row
\li \inlineimage completion/slot.png
\li A slot
\row
\li \inlineimage completion/slot_priv.png
\li A private slot
\row
\li \inlineimage completion/slot_prot.png
\li A protected slot
\row
\li \inlineimage completion/keyword.png
\li A C++ keyword
\row
\li \inlineimage completion/snippet.png
\li A C++ code snippet
\row
\li \inlineimage completion/element.png
\li A QML type
\row
\li \inlineimage completion/qmlsnippet.png
\li A QML code snippet
\row
\li \inlineimage completion/macro.png
\li A macro
\row
\li \inlineimage completion/namespace.png
\li A namespace
\endtable
\section2 Completing Code Snippets
Code snippets can consist of multiple variables that you specify values for.
Select an item in the list and press \key Tab or \key Enter to complete the
code. Press \key Tab to move between the variables and specify values for
them. When you specify a value for a variable, all instances of the variable
within the snippet are renamed.
\image qmldesigner-code-completion.png "Completing QML code"
\section2 Editing Code Snippets
Code snippets specify C++ or QML code constructs. You can add, modify,
and remove snippets in the snippet editor. To open the editor, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol Snippets.
\image qtcreator-edit-code-snippets.png "Snippet options"
\QC provides you with built-in snippets in the following categories:
\list
\li Text snippets, which can contain any text string. For example, code
comments
\li C++ code snippets, which specify C++ code constructs
\li QML code snippets, which specify QML code constructs
\li Nim code snippets, which specify Nim code constructs
\endlist
\section3 Adding and Editing Snippets
Select a snippet in the list to edit it in the snippet editor. To add a new
snippet, select \uicontrol Add. Specify a trigger and, if the trigger is
already in use, an optional variant, which appear in the list of suggestions
when you write code. Also specify a text string or C++ or QML code construct
in the snippet editor, depending on the snippet category. You can use
\l{Using Qt Creator Variables}{predefined variables} in snippets.
The snippet editor provides you with:
\list
\li Highlighting
\li Indentation
\li Parentheses matching
\li Basic code completion
\endlist
Specify the variables for the snippets in the following format:
\code
$variable$
\endcode
Specify \QC variables in the following format:
\code
%{variable}
\endcode
For example, the following variable expands to the name of the current
project: \c {%{CurrentProject:Name}}.
Use unique variable names within a snippet, because all instances of a
variable are renamed when you specify a value for it.
To determine the case of values you enter in snippets, use the following
modifiers:
\list
\li \c {:c} converts the initial letter of the string to upper case
\li \c {:l} converts the string to lower case
\li \c {:u} converts the string to upper case
\endlist
For example, add the following line to the \c class snippet to specify that
the function name is converted to all lower case characters regardless of
how you specify the value of the \c{$name$} variable:
\code
void $name:l$() {}
\endcode
\image qtcreator-snippet-modifiers.png
The snippet editor does not check the syntax of the snippets that you edit
or add. However, when you use the snippets, the code editor marks any
errors by underlining them in red.
To discard the changes you made to a built-in snippet, select
\uicontrol {Revert Built-in}.
\section3 Removing Snippets
Several similar built-in snippets might be provided for different use cases.
To make the list of suggestions shorter when you write code, remove the
built-in snippets that you do not need. If you need them later, you can
restore them.
To remove snippets, select a snippet in the list, and then select
\uicontrol Remove. To restore the removed snippets, select
\uicontrol {Restore Removed Built-ins}.
\section3 Resetting Snippets
To remove all added snippets and to restore all removed snippets, select
\uicontrol {Reset All}.
\note If you now select \uicontrol OK or \uicontrol Apply, you permanently
lose all your own snippets.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage qt-quick-toolbars.html
\page creator-editor-codepasting.html
\nextpage creator-macros.html
\title Pasting and Fetching Code Snippets
In \QC, you can paste snippets of code to a server or fetch snippets of code
from the server. To paste and fetch snippets of code, \QC uses the
following:
\list
\li \uicontrol {Pastebin.Com}
\li \uicontrol {Pastebin.Ca}
\li \uicontrol {Paste.KDE.Org}
\li \uicontrol {Shared network drives}
\endlist
\section1 Specifying Settings for Code Pasting
To specify settings for the code pasting service:
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Code Pasting}.
\image qtcreator-code-pasting-options.png "Code Pasting options"
\li In the \uicontrol {Default protocol} field, select a code pasting
service to use by default.
\li In the \uicontrol Username field, enter your username.
\li In the \uicontrol {Expires after} field, specify the time to keep
the pasted snippet on the server.
\li Select the \uicontrol {Copy-paste URL to clipboard} check box to
copy the URL of the post on the code pasting service to the
clipboard when you paste a post.
\li Select the \uicontrol {Display Output pane after sending a post}
check box to display the URL in the \uicontrol {General Messages}
output pane when you paste a post.
\endlist
Select \uicontrol Fileshare to specify the path to a shared network drive.
The code snippets are copied to the drive as simple files. You have to
delete obsolete files from the drive manually.
\section1 Using Code Pasting Services
To paste a snippet of code onto the server, select \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Paste Snippet} or press
\key {Alt+C,Alt+P}. By default, \QC copies the URL of the snippet to the
clipboard and displays the URL in the \uicontrol {General Messages} output
pane.
To paste any content that you copied to the clipboard, select
\uicontrol Tools > \uicontrol {Code Pasting} > \uicontrol {Paste Snippet}.
To paste content from the \l{Comparing Files}{diff editor}, right-click a
chunk and select \uicontrol {Send Chunk to CodePaster} in the context menu.
To fetch a snippet of code from the server, select \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Fetch Snippet} or press
\key {Alt+C,Alt+F}. Select the snippet to fetch from the list.
To fetch the content stored at an URL, select \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Fetch from URL}.
For example, you might ask colleagues to review a change that you plan to
submit to a version control system. If you use the Git version control
system, you can create a \e{diff} view by selecting \uicontrol Tools >
\uicontrol Git > \uicontrol {Local Repository} > \uicontrol Diff. You can
then upload its contents to the server by selecting \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Paste Snippet}. The reviewers can
retrieve the code snippet by selecting \uicontrol Tools >
\uicontrol {Code Pasting} > \uicontrol {Fetch Snippet}. If they have the
project currently opened in \QC, they can apply and test the change by
choosing \uicontrol Tools > \uicontrol Git > \uicontrol {Patch} >
\uicontrol {Apply from Editor}.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-editor-codepasting.html
\page creator-macros.html
\nextpage creator-diff-editor.html
\title Using Text Editing Macros
To record a text editing macro, select \uicontrol Tools >
\uicontrol {Text Editing Macros} > \uicontrol {Record Macro}
or press \key {Alt+(}. To stop recording, select \uicontrol Tools >
\uicontrol {Text Editing Macros} > \uicontrol {Stop Recording Macro} or
press \key {Alt+)}.
\note The macro recorder does not support code completion.
To play the last macro, select \uicontrol Tools >
\uicontrol {Text Editing Macros} > \uicontrol {Play Last Macro} or
press \key {Alt+R}.
To save the last macro, select \uicontrol Tools >
\uicontrol {Text Editing Macros} > \uicontrol {Save Last Macro}.
To assign a keyboard shortcut to a text editing macro, select
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol Keyboard. For more information, see
\l{Configuring Keyboard Shortcuts}.
You can also use the \c rm locator filter to run a macro. For more
information, see \l{Searching with the Locator}.
To view and remove saved macros, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol Macros.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-editor-options-text.html
\page creator-editor-fakevim.html
\nextpage creator-mime-types.html
\title Using FakeVim Mode
In the \uicontrol FakeVim mode, you can run the main editor in a manner
similar to the Vim editor. To run the editor in the \uicontrol FakeVim
mode, select \uicontrol Edit > \uicontrol Advanced >
\uicontrol {Use Vim-style Editing} or press \key {Alt+V,Alt+V}.
In the \uicontrol FakeVim mode, most keystrokes in the main editor will be
intercepted and interpreted in a way that resembles Vim. Documentation for
Vim is not included in \QC. For more information on using Vim, see
\l{http://www.vim.org/docs.php}{Documentation} on the Vim web site.
To map commands entered on the \uicontrol FakeVim command line to actions
of the \QC core, select \uicontrol Tools > \uicontrol Options >
\uicontrol FakeVim > \uicontrol {Ex Command Mapping}.
To map \e {user commands} to keyboard shortcuts, select \uicontrol Tools >
\uicontrol Options > \uicontrol FakeVim >
\uicontrol {User Command Mapping}. The user command mapped to the shortcut
is executed by FakeVim as if you were typing it (as when replaying a macro).
To make changes to the Vim-style settings, select \uicontrol Tools >
\uicontrol Options > \uicontrol FakeVim > \uicontrol General.
\image qtcreator-fakevim-options.png "FakeVim options"
To preselect the indentation settings specified for the text editor, select
\uicontrol {Copy Text Editor Settings}. To preselect the Qt coding style,
select \uicontrol {Set Qt Style}. To preselect a simple indentation style,
select \uicontrol {Set Plain Style}. You can then change any of the
preselected settings.
To use a Vim-style color scheme, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol {Fonts & Color}.
In the \uicontrol {Color Scheme} list, select \uicontrol {Vim (dark)}.
To quit the FakeVim mode, unselect \uicontrol Tools > \uicontrol Options >
\uicontrol FakeVim > \uicontrol {Use FakeVim} or press \key {Alt+V,Alt+V}.
You can temporarily escape FakeVim mode to access the normal \QC keyboard
shortcuts like \key {Ctrl-R} for \uicontrol Run by pressing \key {,} first.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-completing-code.html
\page creator-indenting-code.html
\nextpage qt-quick-toolbars.html
\title Indenting Text or Code
When you type text or code, it is indented automatically according to the
selected text editor or code style options. Select a block to indent it when
you press \key Tab. Press \key {Shift+Tab} to decrease the indentation. You
can disable automatic indentation.
You can specify indentation for:
\list
\li C++ files
\li QML files
\li Nim files
\li Other text files
\endlist
You can also specify indentation separately for each project. You can
specify several sets of code style settings and easily switch between them.
In addition, you can import and export code style settings.
\section1 Indenting C++ Files
To specify indentation settings for the C++ editor:
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {C++}.
\li In the \uicontrol {Current settings} field, select the settings to
modify and click \uicontrol Copy.
\image qtcreator-options-code-style-cpp.png "C++ Code Style options"
\li Give a name to the settings and click \uicontrol OK.
\li Click \uicontrol Edit to specify code style settings for the project.
\image qtcreator-code-style-settings-edit-cpp.png "Edit Code Style Settings dialog"
\endlist
You can specify how to:
\list
\li Interpret the \key Tab and \key Backspace key presses.
\li Indent the contents of classes, functions, blocks, and namespaces.
\li Indent braces in classes, namespaces, enums, functions, and blocks.
\li Control switch statements and their contents.
\li Align continuation lines.
\li Bind pointers (*) and references (&) in types and declarations to
identifiers, type names, or left or right \c const or \c volatile
keywords.
\li Name getter functions.
\endlist
You can use the live preview to see how the options change the indentation.
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style Settings}.
\section1 Indenting QML Files
To specify settings for the Qt Quick editor:
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Qt Quick}.
\li In the \uicontrol {Current settings} field, select the settings to
modify and click \uicontrol Copy.
\image qtcreator-options-code-style-qml.png "QML Code Style options"
\li Give a name to the settings and click \uicontrol OK.
\li Click \uicontrol Edit to specify code style settings for the project.
\image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings dialog"
\endlist
You can specify how to interpret the \key Tab key presses and how to align
continuation lines.
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style Settings}.
\section1 Indenting Nim Files
To specify settings for the Nim editor (experimental):
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Nim.
\li In the \uicontrol {Current settings} field, select the settings to
modify and click \uicontrol Copy.
\image qtcreator-options-code-style-nim.png "Nim Code Style options"
\li Give a name to the settings and click \uicontrol OK.
\li Click \uicontrol Edit to specify code style settings for the project.
\image qtcreator-code-style-settings-edit-nim.png "Edit Code Style Settings dialog"
\endlist
You can specify how to interpret the \key Tab key presses and how to align
continuation lines.
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol {Code Style}.
\section1 Indenting Other Text Files
To specify indentation settings for text files that do not contain C++ or
QML code (such as Python code files), select \uicontrol Tools >
\uicontrol Options > \uicontrol {Text Editor} > \uicontrol Behavior.
\image qtcreator-indentation.png "Text Editor Behavior options"
To specify different settings for a particular project, select
\uicontrol Projects > \uicontrol Editor.
You can specify how to interpret the \key Tab and \key Backspace key
presses and how to align continuation lines.
\section1 Specifying Tab Settings
You can specify tab settings at the following levels:
\list
\li For all C++ files
\li For all QML files
\li For all other text files
\li For C++ files in a project
\li For QML files in a project
\li For other text files in a project
\endlist
\section2 Specifying Tabs and Indentation
You can specify tab policy and tab size in the
\uicontrol {Tabs and Indentation} group. In
the \uicontrol {Tab policy} field, select whether to use only spaces or
only tabs for indentation, or to use a mixture of them.
By default, the tab length in code editor is 8 spaces and the indent size is
4 spaces. You can specify the tab length and indent size separately for each
project and for different types of files.
You can have continuation lines aligned with the previous line. In the
\uicontrol {Align continuation lines} field, select
\uicontrol {Not at all} to disable automatic alignment and indent
continuation lines to the logical depth. To always use spaces for alignment,
select \uicontrol {With Spaces}. To follow the \uicontrol {Tab policy},
select \uicontrol {With Regular Indent}.
\section2 Specifying Typing Options
When you type text or code, it is indented automatically according to the
selected text editor or code style options. Specify typing options in the
\uicontrol Typing group. To disable automatic indentation, deselect the
\uicontrol {Enable automatic indentation} check box.
You can specify how the indentation is decreased when you press
\uicontrol Backspace in the \uicontrol {Backspace indentation} field. To go
back one space at a time, select \uicontrol None. To decrease indentation
in leading white space by one level, select
\uicontrol {Follows Previous Indents}. To move back one tab length if the
character to the left of the cursor is a space, select
\uicontrol Unindents.
You can specify whether the \key Tab key automatically indents text when you
press it. To automatically indent text, select \uicontrol Always in the
\uicontrol {Tab key performs auto-indent} field. To only indent text when
the cursor is located within leading white space, select \uicontrol {In
Leading White Space}.
\section1 Specifying Settings for Content
You can indent public, protected, and private statements and declarations
related to them within classes.
You can also indent statements within functions and blocks and declarations
within namespaces.
\image qtcreator-code-style-content.png "Content options"
\section1 Specifying Settings for Braces
You can indent class, namespace, enum and function declarations and code
blocks.
\image qtcreator-code-style-braces.png "Braces options"
\section1 Specifying Settings for Switch Statements
You can indent case or default statements, or statements or blocks related
to them within switch statements.
\image qtcreator-code-style-switch.png "Switch options"
\section1 Specifying Alignment
To align continuation lines to tokens after assignments, such as \c = or
\c +=, select the \uicontrol {Align after assignments} check box. You can
specify additional settings for aligning continuation lines in the
\uicontrol General tab.
You can also add spaces to conditional statements, so that they are not
aligned with the following line. Usually, this only affects \c if
statements.
\image qtcreator-code-style-alignment.png "Alignment options"
\section1 Binding Pointers and References
To bind pointers (\c *) and references (\c &) in types and declarations to
identifiers, type names, or left or right \c const or \c volatile keywords,
select the check boxes in the \uicontrol {Pointers and References} tab.
The \c * and \c & characters are automatically bound to identifiers of
pointers to functions and pointers to arrays.
\image qtcreator-pointers-references.png "Pointers and References options"
\section1 Naming Getters
To prefer getter names without the string \e get, select the
\uicontrol {Prefer getter names without "get"} check box in the
\uicontrol {Getter and Setter} tab.
\image qtcreator-code-style-getter-setter.png
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-finding-overview.html
\page creator-editor-finding.html
\nextpage creator-editor-locator.html
\title Finding and Replacing
To search through the currently open file:
\list 1
\li Press \key {Ctrl+F} or select \uicontrol Edit >
\uicontrol {Find/Replace} > \uicontrol {Find/Replace}.
\li Enter the text you are looking for.
If the text is found, all occurrences are highlighted as you type.
\li To go to the next occurrence, click \inlineimage next.png
(\uicontrol {Find Next}), or press \key F3. To go to the previous
occurrence click \inlineimage prev.png
(\uicontrol {Find Previous}), or press \key {Shift+F3}.
\endlist
You can restrict the search in the \uicontrol Find field by selecting one
or several search criteria:
\list
\li To make your search case sensitive, select
\uicontrol {Case Sensitive}.
\li To search only whole words, select \uicontrol {Whole Words Only}.
\li To search using regular expressions, select
\uicontrol {Use Regular Expressions}. Regular expressions used in \QC
are modeled on Perl regular expressions. For more information on
using regular expressions, see the documentation for the
QRegularExpression Class.
\endlist
\note If you have selected text before selecting \uicontrol {Find/Replace}, the
search is conducted within the selection.
To replace occurrences of the existing text, enter the new text in the
\uicontrol {Replace with} field.
\list
\li To replace the selected occurrence and move to the next one,
click \uicontrol {Find Next} or press \key {Ctrl+=}.
\li To replace the selected occurrence and move to the previous one,
click \uicontrol {Find Previous}.
\li To replace all occurrences in the file, click
\uicontrol {Replace All}.
\endlist
The \uicontrol {Preserve Case when Replacing} option can be selected to
preserve the case of the original text when replacing. This option is not
compatible with the \uicontrol {Use Regular Expressions} search option, and will
thus be disabled when regular expressions are used. When the option is used,
the case of the occurrence will be conserved, according to the following
rules:
\list
\li All upper-case occurrences are replaced with the upper-case new
text.
\li All lower-case occurrences are replaced with the lower-case new
text.
\li Capitalized occurrences are replaced with the capitalized new text.
\li Other occurrences are replaced with the new text as entered.
\li If an occurrence and the new text have the same prefix or suffix,
then the case of the prefix and/or suffix are preserved, and the
other rules are applied on the rest of the occurrence only.
\endlist
The locations of search hits, breakpoints, and bookmarks in your document
are highlighted on the editor scroll bar. To turn highlighting off, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol Display > \uicontrol {Highlight search results on the scrollbar}.
\section1 Advanced Search
To search through projects, files on a file system or currently open files:
\list 1
\li Press \key {Ctrl+Shift+F} or select \uicontrol Edit >
\uicontrol {Find/Replace} > \uicontrol {Advanced Find} >
\uicontrol {Open Advanced Find}.
\li Select the scope of your search:
\list
\li \uicontrol {All Projects} searches files matching the
defined file pattern in all currently open projects.
For example, to search for a string only in \c {.cpp}
and \c {.h} files, enter in \uicontrol {File pattern}
\c {*.cpp,*.h}.
\image qtcreator-search-allprojects.png
\li \uicontrol {Current Project} searches files matching the
defined file pattern only in the project you are currently
editing.
\li \uicontrol {Files in File System} recursively searches files
matching the defined file pattern in the selected directory.
\image qtcreator-search-filesystem.png
Select the \uicontrol {Use Git Grep} check box to use Git to
only search tracked files in the Git work tree. To restrict
the search to the HEAD, a tag, a local or remote branch, or
a commit hash, enter a reference in the field. Leave the
field empty to search through the file system.
\li \uicontrol {Current File} searches only the current file.
\li \uicontrol {Open Documents} searches all open files.
\endlist
\li Enter the text you are looking for and click \uicontrol Search.
\image qtcreator-searchresults.png
A list of files containing the searched text is displayed in the
\uicontrol {Search Results} pane.
\list
\li To see all occurrences in a file, double-click the file name
in the list.
\li To go to an occurrence, double-click it.
\li To repeat the search after you have made changes to the
listed files, for example, select
\uicontrol {Search Again}.
\endlist
\endlist
The search results are stored in the search history from which you can
select earlier searches.
\note You can use \uicontrol {Advanced Find} also to search for symbols. For
more information, see \l{Finding Symbols}.
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-editor-locator.html
\page creator-editor-refactoring.html
\nextpage creator-beautifier.html
\title Refactoring
Refactor code to:
\list
\li Improve internal quality of your application
\li Improve performance and extensibility
\li Improve code readability and maintainability
\li Simplify code structure
\endlist
\section1 Finding Symbols
To find the use of a specific symbol or \l{glossary-component}
{QML component} in your Qt C++ or Qt Quick project:
\list 1
\li In the editor, place the cursor on the symbol or component, and
select:
\list
\li \uicontrol Tools > \uicontrol {C++} > \uicontrol {Find Usages}
\li \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Find Usages}
\li \key {Ctrl+Shift+U}
\endlist
\QC looks for the symbol in the following locations:
\list
\li Files listed as a part of the project
\li Files directly used by the project files (for example, generated
files)
\li Header files of used frameworks and libraries
\endlist
\note You can also select \uicontrol Edit > \uicontrol {Find/Replace} >
\uicontrol {Advanced Find} > \uicontrol {C++ Symbols} to search for
classes, functions, enums, and declarations either from files listed as
part of the project or from all files that are used by the code, such as
include files.
\image qtcreator-search-cpp-symbols.png
\li The \uicontrol {Search Results} pane opens and shows the location
and number of instances of the symbol in the current project.
\image qtcreator-refactoring-find.png
\endlist
You can browse the search results in the following ways:
\list
\li To go directly to an instance, double-click the instance in the
\uicontrol {Search Results} pane.
\li To move between instances, click the \inlineimage next.png
(\uicontrol {Next Item}) button and \inlineimage prev.png
(\uicontrol {Previous Item}) button in the
\uicontrol {Search Results} pane.
\li To expand and collapse the list of all instances, click the
\inlineimage qtcreator-expand.png
(\uicontrol {Expand All}) button.
\li To clear the search results, click the
\inlineimage clean_pane_small.png
(\uicontrol Clear) button.
\endlist
\section1 Renaming Symbols
To rename a specific symbol in a Qt project:
\list 1
\li In the editor, place the cursor on the symbol you would like to
change and select \uicontrol Tools > \uicontrol {C++} >
\uicontrol {Rename Symbol Under Cursor} or
\uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Rename Symbol Under Cursor}. Alternatively, press
\key {Ctrl+Shift+R}.
The \uicontrol {Search Results} pane opens and shows the location
and number of instances of the symbol in the current project.
\image qtcreator-refactoring-replace.png
\li To replace all selected instances, enter the name of the new symbol
in the \uicontrol {Replace with} text box and click
\uicontrol Replace.
To omit an instance, uncheck the check-box next to the instance.
\note This action replaces all selected instances of the symbol in
all files listed in the \uicontrol {Search Results} pane. You cannot
undo this action.
\endlist
\note Renaming local symbols does not open the \uicontrol {Search Results}
pane. The instances of the symbol are highlighted in code and you can edit
the symbol. All instances of the local symbol are changed as you type.
\section1 Column Editing
To apply a change to several rows in a column simultaneously, press
\key Alt, select the rows, and enter or remove text. The changes are made
simultaneously at the cursor position on all the selected rows.
\section1 Applying Refactoring Actions
\QC allows you to quickly and conveniently apply actions to refactor your
code by selecting them in a context menu. The actions available depend on
the position of the cursor in the code editor and on whether you are writing
C++ or QML code.
To apply refactoring actions to C++ code, right-click an operand,
conditional statement, string, or name to open a context menu. In QML code,
click an item ID or name.
In the context menu, select \uicontrol {Refactoring} and then select a
refactoring action.
You can also press \key {Alt+Enter} to open a context menu that contains
refactoring actions available in the current cursor position.
If you use the \l{Parsing C++ Files}{Clang code model} to parse the C++
files, the \l{http://clang.llvm.org/diagnostics.html}{Clang fix-it hints}
that have been integrated into \QC are also available to you. In addition to
the standard ways of activating refactoring actions, you can select the
actions that are applicable on a line in the context menu in the left margin
of the code editor.
\section2 Refactoring C++ Code
You can apply the following types of refactoring actions to C++ code:
\list
\li Change binary operands
\li Simplify if and while conditions (for example, move declarations out
of if conditions)
\li Modify strings (for example, set the encoding for a string to
Latin-1, mark strings translatable, and convert symbol names to
camel case)
\li Create variable declarations
\li Create function declarations and definitions
\endlist
The following table summarizes the refactoring actions for C++ code. The
action is available when the cursor is in the position described in the
Activation column.
\table
\header
\li Refactoring Action
\li Description
\li Activation
\row
\li Add Curly Braces
\li Adds curly braces to an if statement that does not contain a
compound statement. For example, rewrites
\code
if (a)
b;
\endcode
as
\code
if (a) {
b;
}
\endcode
\li \c if
\row
\li Move Declaration out of Condition
\li Moves a declaration out of an if or while condition to simplify
the condition. For example, rewrites
\code
if (Type name = foo()) {}
\endcode
as
\code
Type name = foo;
if (name) {}
\endcode
\li Name of the introduced variable
\row
\li Rewrite Condition Using ||
\li Rewrites the expression according to De Morgan's laws. For
example, rewrites:
\code
!a && !b
\endcode
as
\code
!(a || b)
\endcode
\li \c &&
\row
\li Rewrite Using \e operator
\li Rewrites an expression negating it and using the inverse
operator. For example, rewrites:
\list
\li \code
a op b
\endcode
as
\code
!(a invop b)
\endcode
\li \code
(a op b)
\endcode
as
\code
!(a invop b)
\endcode
\li \code
!(a op b)
\endcode
as
\code
(a invob b)
\endcode
\endlist
\li \c {<=}, \c {<}, \c {>}, \c {>=}, \c {==} or \c {!=}
\row
\li Split Declaration
\li Splits a simple declaration into several declarations. For
example, rewrites:
\code
int *a, b;
\endcode
as
\code
int *a;
int b;
\endcode
\li Type name or variable name
\row
\li Split if Statement
\li Splits an if statement into several statements. For example,
rewrites:
\code
if (something && something_else) {
}
\endcode
as
\code
if (something) {
if (something_else) {
}
}
\endcode
and
\code
if (something || something_else)
x;
\endcode
with
\code
if (something)
x;
else if (something_else)
x;
\endcode
\li \c && or \c ||
\row
\li Swap Operands
\li Rewrites an expression in the inverse order using the inverse
operator. For example, rewrites:
\code
a op b
\endcode
as
\code
b flipop a
\endcode
\li \c {<=}, \c {<}, \c {>}, \c {>=}, \c {==}, \c {!=}, \c {&&}
or \c {||}
\row
\li Convert to Decimal
\li Converts an integer literal to decimal representation
\li Numeric literal
\row
\li Convert to Hexadecimal
\li Converts an integer literal to hexadecimal representation
\li Numeric literal
\row
\li Convert to Octal
\li Converts an integer literal to octal representation
\li Numeric literal
\row
\li Convert to Objective-C String Literal
\li Converts a string literal to an Objective-C string literal if
the file type is Objective-C(++). For example, rewrites the
following strings
\code
"abcd"
QLatin1String("abcd")
QLatin1Literal("abcd")
\endcode
as
\code
@"abcd"
\endcode
\li String literal
\row
\li Enclose in QLatin1Char()
\li Sets the encoding for a character to Latin-1, unless the
character is already enclosed in QLatin1Char, QT_TRANSLATE_NOOP,
tr, trUtf8, QLatin1Literal, or QLatin1String. For example,
rewrites
\code
'a'
\endcode
as
\code
QLatin1Char('a')
\endcode
\li String literal
\row
\li Enclose in QLatin1String()
\li Sets the encoding for a string to Latin-1, unless the string is
already enclosed in QLatin1Char, QT_TRANSLATE_NOOP, tr, trUtf8,
QLatin1Literal, or QLatin1String. For example, rewrites
\code
"abcd"
\endcode
as
\code
QLatin1String("abcd")
\endcode
\li String literal
\row
\li Mark as Translatable
\li Marks a string translatable. For example, rewrites \c "abcd"
with one of the following options, depending on which of them is
available:
\code
tr("abcd")
QCoreApplication::translate("CONTEXT", "abcd")
QT_TRANSLATE_NOOP("GLOBAL", "abcd")
\endcode
\li String literal
\row
\li Add Definition in ...
\li Inserts a definition stub for a function declaration either in
the header file (inside or outside the class) or in the
implementation file. For free functions, inserts the definition
after the declaration of the function or in the implementation
file. Qualified names are minimized when possible, instead of
always being fully expanded.
For example, rewrites
\code
Class Foo {
void bar();
};
\endcode
as (inside class)
\code
Class Foo {
void bar() {
}
};
\endcode
as (outside class)
\code
Class Foo {
void bar();
};
void Foo::bar()
{
}
\endcode
as (in implementation file)
\code
// Header file
Class Foo {
void bar();
};
// Implementation file
void Foo::bar()
{
}
\endcode
\li Function name
\row
\li Add \c Function Declaration
\li Inserts the member function declaration that matches the member
function definition into the class declaration. The function can
be \c {public}, \c {protected}, \c {private}, \c {public slot},
\c {protected slot}, or \c {private slot}.
\li Function name
\row
\li Switch with Next/Previous Parameter
\li Moves a parameter down or up one position in a parameter list.
\li Parameter in the declaration or definition of a function
\row
\li Extract Function
\li Moves the selected code to a new function and replaces the block
of code with a call to the new function. Enter a name for the
function in the \uicontrol {Extract Function Refactoring}
dialog.
\li Block of code selected
\row
\li Extract Constant as Function Parameter
\li Replaces the selected literal and all its occurrences with the
function parameter \c{newParameter}. The parameter
\c{newParameter} will have the original literal as the default
value.
\li Block of code selected
\row
\li Add Local Declaration
\li Adds the type of an assignee, if the type of the right-hand
side of the assignment is known. For example, rewrites
\code
a = foo();
\endcode
as
\code
Type a = foo();
\endcode
where Type is the return type of \c {foo()}
\li Assignee
\row
\li Convert to Camel Case
\li Converts a symbol name to camel case, where elements of the name
are joined without delimiter characters and the initial
character of each element is capitalized. For example, rewrites
\c an_example_symbol as \c anExampleSymbol and
\c AN_EXAMPLE_SYMBOL as \c AnExampleSymbol
\li Identifier
\row
\li Complete Switch Statement
\li Adds all possible cases to a switch statement of the type
\c enum
\li \c switch
\row
\li Generate Missing Q_PROPERTY Members
\li Adds missing members to a \c Q_PROPERTY:
\list
\li \c read function
\li \c write function, if there is a WRITE
\li \c {onChanged} signal, if there is a NOTIFY
\li data member with the name \c {m_<propertyName>}
\endlist
\li \c Q_PROPERTY
\row
\li Apply Changes
\li Keeps function declarations and definitions synchronized by
checking for the matching declaration or definition when you
edit a function signature and by applying the changes to the
matching code.
\li Function signature. When this action is available, a light bulb
icon appears: \inlineimage refactormarker.png
\row
\li Add #include for undeclared or forward declared identifier
\li Adds an \c {#include} directive to the current file to make the
definition of a symbol available.
\li Undeclared identifier
\row
\li Reformat Pointers or References
\li Reformats declarations with pointers or references according
to the code style settings for the current project. In case no
project is open, the current global code style settings are
used.
For example, rewrites:
\code
char*s;
\endcode
as
\code
char *s;
\endcode
When applied to selections, all suitable declarations in the
selection are rewritten.
\li Declarations with pointers or references and selections
containing such declarations
\row
\li Create Getter and Setter Member Functions
\li Creates either both getter and setter member functions for
member variables or only a getter or setter.
\li Member variable in class definition
\row
\li Move Function Definition
\li Moves a function definition to the implementation file, outside
the class or back to its declaration. For example, rewrites:
\code
class Foo
{
void bar()
{
// do stuff here
}
};
\endcode
as
\code
class Foo
{
void bar();
};
void Foo::bar() {
// do stuff here
}
\endcode
\li Function signature
\row
\li Move All Function Definitions
\li Moves all function definitions to the implementation file or
outside the class. For example, rewrites:
\code
class Foo
{
void bar()
{
// do stuff here
}
void baz()
{
// do stuff here
}
};
\endcode
as
\code
class Foo
{
void bar();
void baz();
};
void Foo::bar() {
// do stuff here
}
void Foo::baz() {
// do stuff here
}
\endcode
\li Class name
\row
\li Assign to Local Variable
\li Adds a local variable which stores the return value of a
function call or a new expression. For example, rewrites:
\code
QString s;
s.toLatin1();
\endcode
as
\code
QString s;
QByteArray latin1 = s.toLatin1();
\endcode
and
\code
new Foo;
\endcode
as
\code
Foo * localFoo = new Foo;
\endcode
\li Function call or class name
\row
\li Insert (Pure) Virtual Functions
\li Select an insertion mode:
\list
\li Insert only declarations.
\li Insert declarations and the corresponding definitions inside the class.
\li Insert declarations and the corresponding definitions outside the class.
\li Insert declarations and the corresponding definitions in the implementation file
(only if an implementation file exists).
\endlist
\image qtcreator-refactoring-virtual-function-dialog.png
\li Class or base class name
\row
\li Optimize for-Loop
\li Rewrites post increment operators as pre increment operators and
post decrement operators as pre decrement operators. It also
moves other than string or numeric literals and id expressions
from the condition of a for loop to its initializer. For
example, rewrites:
\code
for (int i = 0; i < 3 * 2; i++)
\endcode
as
\code
for (int i = 0, total = 3 * 2; i < total; ++i)
\endcode
\li \c for
\row
\li Escape String Literal as UTF-8
\li Escapes non-ASCII characters in a string literal to hexadecimal
escape sequences. String Literals are handled as UTF-8.
\li String literal
\row
\li Unescape String Literal as UTF-8
\li Unescapes octal or hexadecimal escape sequences in a string
literal. String Literals are handled as UTF-8.
\li String literal
\row
\li Convert to Stack Variable
\li Converts the selected pointer to a stack variable. For example,
rewrites:
\code
QByteArray *foo = new QByteArray("foo");
foo->append("bar");
\endcode
as
\code
QByteArray foo = "foo";
foo.append("bar");
\endcode
This operation is limited to work only within function scope.
Also, the coding style for pointers and references is not
respected yet.
\li Pointer Variable
\row
\li Convert to Pointer
\li Converts the selected stack variable to a pointer. For example,
rewrites:
\code
QByteArray foo = "foo";
foo.append("bar");
\endcode
as
\code
QByteArray *foo = new QByteArray("foo");
foo->append("bar");
\endcode
This operation is limited to work only within function scope.
Also, the coding style for pointers and references is not
respected yet.
\li Stack Variable
\row
\li Convert connect() to Qt 5 Style
\li Converts a Qt 4 QObject::connect() to Qt 5 style.
\li QObject::connect() (Qt 4 style)
\endtable
\section2 Refactoring QML Code
You can apply the following types of refactoring actions to QML code:
\list
\li Rename IDs
\li Split initializers
\li Move a QML type into a separate file to reuse it in other .qml files
\endlist
The following table summarizes the refactoring actions for QML code. The
action is available when the cursor is in the position described in the
Activation column.
\table
\header
\li Refactoring Action
\li Description
\li Activation
\row
\li Move Component into Separate File
\li Moves a QML type into a separate file
\li QML type name
\row
\li Split Initializer
\li Reformats a one-line type into a multi-line type. For example,
rewrites
\code
Item { x: 10; y: 20; width: 10 }
\endcode
as
\code
Item {
x: 10;
y: 20;
width: 10
}
\endcode
\li QML type property
\row
\li Wrap Component in Loader
\li Wraps the type in a Component type and loads it dynamically in a
Loader type. This is usually done to improve startup time.
\li QML type name
\row
\li Add a message suppression comment
\li Prepends the line with an annotation comment that stops the
message from being generated.
\li Error, warning or hint from static analysis
\endtable
*/
/*!
\contentspage {Qt Creator Manual}
\previouspage creator-editor-finding.html
\page creator-editor-locator.html
\nextpage creator-editor-refactoring.html
\title Searching with the Locator
You can find the locator in the bottom left of the \QC window.
\image qtcreator-locator.png
To activate the locator:
\list
\li Press \key {Ctrl+K} (\key {Cmd+K} on \macos).
\li Select \uicontrol Tools > \uicontrol Locate.
\li Select \uicontrol Edit > \uicontrol {Go to Line}.
\li Click the line and column indicator on the
\l{Using the Editor Toolbar}{editor toolbar}.
\endlist
To edit the currently open project's main.cpp file using the locator:
\list 1
\li Activate the locator by pressing \key {Ctrl+K}.
\li Enter \c {main.cpp}.
\image qtcreator-locator-open.png
\li Press \key Enter.
The \c {main.cpp} file opens in the editor.
\li To move to a line in the file, enter the line number in the locator.
\endlist
To move directly to a particular line and column in the document when you
open the document, append them to the file name in the locator, separated by
plus signs (+) or colons (:). For example, to open main.cpp to line 41 and
column 2, enter: \c {main.cpp:41:2}.
If the path to a file is very long, it might not fit into the locator
window. To view the full path, press \key Alt when the filename is selected
or use the handle next to the locator window to increase the window width.
It is also possible to enter only a part of a search string. As you type,
the locator shows the occurrences of that string regardless of where in the
name of an component it appears.
To narrow down the search results, you can use the following wildcard
characters:
\list
\li To match any number of any or no characters, enter \c{*}.
\li To match a single instance of any character, enter \c{?}.
\endlist
\section1 Using Locator Filters
The locator enables you to browse not only files, but any items defined by
\b{locator filters}. By default, the locator contains filters for:
\list
\li Locating any open document (\c {o})
\li Locating files anywhere on your file system (\c {f})
\li Locating files belonging to your project (\c {p}), such as source,
header resource, and \c {.ui} files, or to any project (\c {a})
\li Locating class (\c {c}), enum, and function (m) definitions in your
project or anywhere referenced from your project (\c {:})
\li Locating symbols in the current document (\c {.})
\li Locating a specific line and column in the document displayed in
your editor (\c {l <line_number>:<column_number>})
\li Opening help topics, including Qt documentation (\c {?})
\li Performing web searches (\c {r})
\li Running text editing macros that you record and save (\c {rm}). For
more information, see \l{Using Text Editing Macros}
\li Executing shell commands (\c {!})
\li Executing version control system commands (\c {git}). For more
information, see \l{Using Version Control Systems}
\li Running external tools (\c x)
\endlist
To use a specific locator filter, type the assigned prefix followed by
\key Space. The prefix is usually a single character. Then type the search
string (typically, a filename or class name) or the command to execute.
You can also double-click a locator filter in the filter list to use it. You
can use the up and down arrow keys or the \key Ctrl+P and \key Ctrl+N
keyboard shortcuts to move up and down the list, and then press \key Enter
to use the selected filter.
For example, to locate symbols matching QDataStream:
\list 1
\li Activate the locator.
\li Enter \c{: QDataStream} (\c{:} (colon) followed by a
\key Space and the symbol name (QDataStream)).
The locator lists the results.
\image qtcreator-navigate-popup.png
\endlist
Filters locating files also accept paths, such as \c {tools/*main.cpp}.
Filters locating class and function definitions also accept namespaces,
such as \c {Utils::*View}.
For example, to create a new file and open it in the editor, type \c f
followed by \key Space, followed by path and file name, and then press
\key Enter.
By default, the following filters are enabled and you do not need to use
their prefixes explicitly:
\list
\li Going to a line and column in the current file (\c {l}).
\li Going to an open file (\c {o}).
\li Going to a file in any open project (\c {a}).
\endlist
If locator does not find some files, you can add them to the \c DISTFILES
variable in the \c .pro file to include them into the distribution tarball
of your project and thus make them known to \QC as well.
\section1 Configuring Locator Filters
If the default filters do not match your use case, you can check whether you
can change them. For all filters, you can change the filter prefix and
restrict the search to items that match the filter.
To configure a locator filter:
\list 1
\li In the locator, click \inlineimage magnifier.png
(\uicontrol Options) and select \uicontrol Configure to open the
\uicontrol Locator options.
\li Select a filter, and then select \uicontrol Edit.
\li Specify the prefix string.
\li To implicitly include the filter even when not typing a prefix as a
part of the search string, select \uicontrol {Include by default}.
\li Specify other available options. For more information, see
\l{Adding Web Search Engines}.
\endlist
\section2 Adding Web Search Engines
You can use the \uicontrol {Web Search (r)} locator filter to perform
web searches. URLs and search commands for Bing, Google, Yahoo! Search,
cplusplus.com, and Wikipedia are configured by default.
To find out the format of the search command to use for your favorite
web search engine, perform a search in your browser and copy the resulting
URL to the locator filter configuration. Replace the search term with the
variable \c {%1}.
To add URLs and search commands to the list:
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment > \uicontrol Locator >
\uicontrol {Web Search (prefix: r)} > \uicontrol Edit.
\li Select \uicontrol Add to add a new entry to the list.
\image qtcreator-add-online-doc.png "Filter Configuration dialog"
\li Double-click the new entry to specify a URL and a search command.
For example, \c {http://www.google.com/search?q=%1}.
\li Click \uicontrol OK.
\endlist
\section1 Creating Locator Filters
To quickly access files not directly mentioned in your project, you can
create your own locator filters. That way you can locate files in a
directory structure you have defined.
To create a locator filter:
\list 1
\li In the locator, select \uicontrol Options >
\uicontrol Configure to open the \uicontrol Locator options.
\image qtcreator-locator-customize.png
\li Click \uicontrol Add.
\li In the \uicontrol {Filter Configuration} dialog:
\list
\li Name your filter.
\li Select at least one directory. The locator searches directories
recursively.
\li Define the file pattern as a comma separated list. For example,
to search all \c {.h} and \c {.cpp} files, enter \c{*.h,*.cpp}
\li Specify the prefix string.
To implicitly include the filter even when not typing a prefix
as a part of the search string, select
\uicontrol {Include by default}.
\image qtcreator-navigate-customfilter.png
\endlist
\li Click \uicontrol OK.
\endlist
\section1 Configuring Locator Cache
The locator searches the files matching your file pattern in the directories
you have selected and caches that information. The cache for all default
filters is updated as you write your code. By default, \QC updates the
filters created by you once an hour.
To update the cached information manually, select \uicontrol Options >
\uicontrol Refresh in the locator.
To set a new cache update time:
\list 1
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment > \uicontrol Locator.
\li In \uicontrol {Refresh interval}, define new time in minutes.
\endlist
*/
|