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
|
/****************************************************************************
**
** Copyright (C) 2021 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.
**
****************************************************************************/
/*!
\page creator-editor-refactoring.html
\previouspage creator-editor-locator.html
\nextpage creator-editor-quick-fixes.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
\QC allows you to quickly and conveniently apply actions to refactor your
code by selecting them in a context menu. For more information, see
\l{Applying Refactoring Actions}.
By default, the refactored files are saved automatically. To disable
this feature, deselect \uicontrol Tools > \uicontrol Options >
\uicontrol System > \uicontrol {Auto-save files after refactoring}.
\if defined(qtcreator)
\section1 Finding Symbols
To find instances of a specific symbol in your Qt C++ project, place the
cursor on the symbol in the editor and select \uicontrol Tools >
\uicontrol {C++} > \uicontrol {Find References to Symbol Under Cursor} or
press \key {Ctrl+Shift+U}.
\image qtcreator-find-references-to-symbol-under-cursor.png "Search results for finding references to symbols"
To view the same results color-coded according to the access type, such as
read, write, or declaration, select \uicontrol Tools > \uicontrol {C++} >
\uicontrol {Find References with Access Type}.
\note You can also select \uicontrol Edit > \uicontrol {Find/Replace} >
\uicontrol {Advanced Find} > \uicontrol {C++ Symbols} to search for
classes, functions, enums, and declarations (including type aliases) 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
\endif
\section1 Finding QML Types
To find instances of a specific QML type in a project, place the cursor on
the type and select \uicontrol Tools > \uicontrol {QML/JS} >
\uicontrol {Find References to Symbol Under Cursor} or press
\key {Ctrl+Shift+U}.
\section1 Viewing Search Results
\QC searches from 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)
\if defined(qtcreator)
\li Header files of used frameworks and libraries
\endif
\endlist
The \uicontrol {Search Results} pane shows the location
and number of search hits in the current project.
\if defined(qtcreator)
\image qtcreator-refactoring-find.png
\else
\image qml-find-usages.png
\endif
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 filter the search results for the usage of symbols according to
access type, such as read, write, or declaration, click the
\inlineimage filtericon.png
(\uicontrol {Filter Tree}) button and select the access type.
\li To clear the search results, click the
\inlineimage clean_pane_small.png
(\uicontrol Clear) button.
\li To start a new search, click the
\inlineimage qtcreator-new-search-icon.png
(\uicontrol {New Search}) button.
\endlist
\section1 Renaming Symbols
You can rename symbols in all files in a project.
\if defined(qtcreator)
When you rename a class, you can also change filenames that match the
class name.
To rename a C++ symbol in a project, place the cursor
on it and select \uicontrol Tools > \uicontrol {C++} >
\uicontrol {Rename Symbol Under Cursor} or press \key {Ctrl+Shift+R}.
Use the keyboard shortcut to rename Python symbols.
\endif
To rename a QML type in a project, select \uicontrol Tools >
\uicontrol {QML/JS} > \uicontrol {Rename Symbol Under Cursor}
or press \key {Ctrl+Shift+R}.
The \uicontrol {Search Results} pane shows the location
and number of instances of the symbol in the current project.
\if defined(qtcreator)
\image qtcreator-refactoring-replace.png
\else
\image qml-rename-symbol.png
\endif
To replace all selected instances, enter the name of the new symbol
in the \uicontrol {Replace with} text box, and select \uicontrol Replace.
To omit an instance, deselect 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.
\if defined(qtcreator)
If the symbol is a class, select the \uicontrol {Rename files} check
box to also change the filenames that match the class name.
\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.
\endif
\section1 Multi-Cursor Editing
To apply a change to several places simultaneously, press and hold \key Alt,
and click to place cursors in several places. Any changes you make are
applied simultaneously at all the cursor positions.
Use the arrow keys to move all the cursors up and down. The \key Home and
\key End key move all the cursors to the beginning or to the end of the
line.
Press and hold \key Alt and double-click strings to select several strings
simultaneously.
Press \key Esc to remove all the cursors and selections.
*/
|
