Doc: Split up the "Working in Edit Mode topic"
- Make topics shorter and easier to browse - Move information around - Delete duplicate how-to topics - Add \sa links to how-to topics Task-number: QTCREATORBUG-29361 Change-Id: Ie84a29993129d175bbd65143fcfc45aa8304d621 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
BIN
doc/qtcreator/images/qtcreator-code-model-inspector.webp
Normal file
After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 8.8 KiB |
BIN
doc/qtcreator/images/qtcreator-editor-multicursor.webp
Normal file
After Width: | Height: | Size: 6.2 KiB |
BIN
doc/qtcreator/images/qtcreator-editor-open-files.webp
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
doc/qtcreator/images/qtcreator-editor-symbols.webp
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
doc/qtcreator/images/qtcreator-editor-toolbar.webp
Normal file
After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 10 KiB |
@@ -674,7 +674,7 @@
|
|||||||
\row
|
\row
|
||||||
\li Editor
|
\li Editor
|
||||||
\li Open the current source file in the text editor for changing it.
|
\li Open the current source file in the text editor for changing it.
|
||||||
\li \l {Working in Edit Mode}
|
\li \l {Edit Mode}
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
\note The \uicontrol Views menu shows some views only while you are
|
\note The \uicontrol Views menu shows some views only while you are
|
||||||
|
@@ -55,7 +55,7 @@
|
|||||||
|
|
||||||
If \QC cannot detect the encoding of the files to compare, an info bar
|
If \QC cannot detect the encoding of the files to compare, an info bar
|
||||||
appears that displays the option to reload the document using some other
|
appears that displays the option to reload the document using some other
|
||||||
encoding. For more information, see \l {File Encoding}.
|
encoding. For more information, see \l {Change text encoding}.
|
||||||
|
|
||||||
\section1 Viewing the Changes
|
\section1 Viewing the Changes
|
||||||
|
|
||||||
|
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
\list
|
\list
|
||||||
\if defined(qtcreator)
|
\if defined(qtcreator)
|
||||||
\li \l{Working in Edit Mode}
|
\li \l{Edit Mode}
|
||||||
|
|
||||||
You can use the editor toolbar to navigate between open files
|
You can use the editor toolbar to navigate between open files
|
||||||
and symbols in use. You can also split the view to work on
|
and symbols in use. You can also split the view to work on
|
||||||
|
@@ -30,7 +30,7 @@
|
|||||||
\li Select \uicontrol Edit > \uicontrol {Go to Line}.
|
\li Select \uicontrol Edit > \uicontrol {Go to Line}.
|
||||||
\if defined(qtcreator)
|
\if defined(qtcreator)
|
||||||
\li Click the line and column indicator on the
|
\li Click the line and column indicator on the
|
||||||
\l{Using the Editor Toolbar}{editor toolbar}.
|
\l{Edit Mode}{editor toolbar}.
|
||||||
\endif
|
\endif
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
@@ -99,6 +99,7 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
Filters locating files also accept paths, such as \c {tools/*main.cpp}.
|
||||||
If the path to a file is very long, it might not fit into the locator
|
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
|
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.
|
or use the handle next to the locator window to increase the window width.
|
||||||
@@ -133,33 +134,6 @@
|
|||||||
HelloWorld.qml:41:2
|
HelloWorld.qml:41:2
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\if defined(qtcreator)
|
|
||||||
\section2 Locating Symbols
|
|
||||||
|
|
||||||
For example, to locate symbols matching \c {QGuiApplication}:
|
|
||||||
|
|
||||||
\list 1
|
|
||||||
|
|
||||||
\li Activate the locator.
|
|
||||||
|
|
||||||
\li Enter a colon (:) followed by a space and the upper case letters in
|
|
||||||
the symbol name (here, \c {QGuiApplication}):
|
|
||||||
|
|
||||||
\code
|
|
||||||
: qga
|
|
||||||
\endcode
|
|
||||||
|
|
||||||
The locator lists the results.
|
|
||||||
|
|
||||||
\image qtcreator-locator-example.webp "List of files matching the locator filter"
|
|
||||||
|
|
||||||
\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}.
|
|
||||||
\endif
|
|
||||||
|
|
||||||
\section2 Creating Files and Directories from Locator
|
\section2 Creating Files and Directories from Locator
|
||||||
|
|
||||||
To create a new file and open it in the editor, type \c f
|
To create a new file and open it in the editor, type \c f
|
||||||
|
@@ -28,7 +28,7 @@
|
|||||||
\li Syntactic and \l{Semantic Highlighting}{semantic highlighting}
|
\li Syntactic and \l{Semantic Highlighting}{semantic highlighting}
|
||||||
|
|
||||||
\li Navigating in the code by using the \l{Searching with the Locator}
|
\li Navigating in the code by using the \l{Searching with the Locator}
|
||||||
{locator}, \l{Moving to Symbol Definition or Declaration}
|
{locator}, \l{Move to symbol definition or declaration}
|
||||||
{following symbols}, and so on
|
{following symbols}, and so on
|
||||||
|
|
||||||
\li Inspecting code by using the \l{Class View}{class browser}, the
|
\li Inspecting code by using the \l{Class View}{class browser}, the
|
||||||
|
@@ -1,211 +1,471 @@
|
|||||||
// Copyright (C) 2023 The Qt Company Ltd.
|
// Copyright (C) 2024 The Qt Company Ltd.
|
||||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\previouspage creator-editor-functions.html
|
|
||||||
\page creator-coding-navigating.html
|
\page creator-coding-navigating.html
|
||||||
\nextpage creator-highlighting.html
|
\previouspage creator-reference.html
|
||||||
|
|
||||||
\title Working in Edit Mode
|
\ingroup creator-reference-editors
|
||||||
|
|
||||||
You can write code in the \uicontrol Edit mode.
|
\title Edit Mode
|
||||||
|
|
||||||
\section1 Using the Editor Toolbar
|
\brief Use the editor toolbar to navigate between open files and symbols in
|
||||||
|
use, split the view to work on several files simultaneously, add bookmarks,
|
||||||
|
and move between symbol definitions and declarations.
|
||||||
|
|
||||||
The editor toolbar is located at the top of the editor view. It is context
|
Write code in the \uicontrol Edit mode.
|
||||||
sensitive and shows items relevant to the file currently open in the editor.
|
|
||||||
|
|
||||||
\image qtcreator-editortoolbar-symbols.webp {Edit mode toolbar}
|
The editor toolbar at the top of the editor view is context sensitive and
|
||||||
|
shows items relevant to the file currently open in the editor.
|
||||||
|
|
||||||
To add more space around the toolbar items, select \preferences >
|
\image qtcreator-editor-toolbar.webp {Edit mode toolbar}
|
||||||
|
|
||||||
|
\table
|
||||||
|
\header
|
||||||
|
\li Button or Field
|
||||||
|
\li Purpose
|
||||||
|
\li Read More
|
||||||
|
\row
|
||||||
|
\li \inlineimage icons/prev.png
|
||||||
|
\inlineimage icons/next.png
|
||||||
|
\li Browse backward or forward through your location history.
|
||||||
|
\li
|
||||||
|
\row
|
||||||
|
\li \inlineimage numbers/01.png
|
||||||
|
\li Go to any open file.
|
||||||
|
\li \l{Move between open files}
|
||||||
|
\row
|
||||||
|
\li \inlineimage numbers/02.png
|
||||||
|
\li Jump to any symbol used in the current file.
|
||||||
|
\li \l{Move to symbols}
|
||||||
|
\row
|
||||||
|
\li \uicontrol #
|
||||||
|
\li Change the active parse context.
|
||||||
|
\li \l {Parse files}
|
||||||
|
\row
|
||||||
|
\li \inlineimage numbers/03.png
|
||||||
|
\li Switch between Windows line endings (CRLF) and Unix line endings (LF).
|
||||||
|
\li \l{Select line ending style}
|
||||||
|
\row
|
||||||
|
\li \inlineimage numbers/04.png
|
||||||
|
\li Change the text encoding.
|
||||||
|
\li \l{Change text encoding}
|
||||||
|
\row
|
||||||
|
\li \inlineimage icons/languageclient.png
|
||||||
|
\li View the language server for the current project, restart it, select
|
||||||
|
another one, \l{Inspect language clients}{inspect the communication}
|
||||||
|
between \QC and language servers, view server capabilities, and set
|
||||||
|
language server preferences.
|
||||||
|
\li \l {Language Servers}
|
||||||
|
\row
|
||||||
|
\li \inlineimage icons/debugger_singleinstructionmode.png
|
||||||
|
\li Run Clang-Tidy or Clazy to analyze the currently open file.
|
||||||
|
\li \l{Analyze code with Clang-Tidy and Clazy}
|
||||||
|
\row
|
||||||
|
\li \inlineimage numbers/05.png
|
||||||
|
\li Jump to a line and column in the current file. The line and column
|
||||||
|
indicator shows information about the current cursor positions,
|
||||||
|
including the length of the selection for selected text.
|
||||||
|
\li
|
||||||
|
|
||||||
|
\endtable
|
||||||
|
|
||||||
|
\section1 Adding Space Around Toolbar Items
|
||||||
|
|
||||||
|
To add more space around the toolbar items, go to \preferences >
|
||||||
\uicontrol Environment > \uicontrol Interface, and
|
\uicontrol Environment > \uicontrol Interface, and
|
||||||
then select \uicontrol Relaxed in the \uicontrol {Toolbar style} field.
|
then select \uicontrol Relaxed in the \uicontrol {Toolbar style} field.
|
||||||
|
|
||||||
\image qtcreator-preferences-environment-interface.webp {Interface tab in Environment preferences}
|
\image qtcreator-preferences-environment-interface.webp {Interface tab in Environment preferences}
|
||||||
|
|
||||||
\section2 Navigating Between Open Files and Symbols
|
\section1 Copying File Information
|
||||||
|
|
||||||
Use the toolbar, \uicontrol Window menu items, or
|
To open a context menu that has commands for managing open files, right-click
|
||||||
\l{General Keyboard Shortcuts}{keyboard shortcuts}
|
the file name or icon on the toolbar (1). It has the same commands as the
|
||||||
to navigate between open files and symbols in use.
|
\uicontrol File menu, as well as commands that copy the path and name of the
|
||||||
|
current file and the number of the line where the cursor is
|
||||||
To browse backward or forward through your
|
currently located to the clipboard: \uicontrol {Copy Full Path},
|
||||||
location history, click \inlineimage icons/prev.png
|
\uicontrol {Copy File Name}, and \uicontrol {Copy Path and Line Number}.
|
||||||
(\uicontrol {Go Back}) and \inlineimage icons/next.png
|
|
||||||
(\uicontrol {Go Forward}).
|
|
||||||
|
|
||||||
To return to the last location where you made a change, select
|
|
||||||
\uicontrol Window > \uicontrol {Go to Last Edit}.
|
|
||||||
|
|
||||||
To go to any open file, select it from the \uicontrol {Open files} drop-down
|
|
||||||
menu (1). To open a context menu that has commands for managing open
|
|
||||||
files, right-click the file name or icon on the toolbar. In addition to the
|
|
||||||
commands also available in the \uicontrol File menu, you can copy the path
|
|
||||||
and name of the current file and the number of the line where the cursor is
|
|
||||||
currently located to the clipboard by selecting \uicontrol {Copy Full Path},
|
|
||||||
\uicontrol {Copy File Name}, or \uicontrol {Copy Path and Line Number}.
|
|
||||||
|
|
||||||
To jump to any symbol used in the current file, select it from the
|
|
||||||
\uicontrol Symbols drop-down menu (2). By default, the symbols are displayed
|
|
||||||
in the order in which they appear in the file. Right-click the menu title
|
|
||||||
and select \uicontrol {Sort Alphabetically} to arrange the symbols in
|
|
||||||
alphabetic order.
|
|
||||||
|
|
||||||
To jump to a line and column in the current file, select the line and column
|
|
||||||
indicator (3) or press \key {Ctrl+K} (or \key {Cmd+K} on \macos) to open the
|
|
||||||
\l{Searching with the Locator}{locator}. Enter the line number and column
|
|
||||||
number in the locator, separated by a colon (:).
|
|
||||||
|
|
||||||
The line and column indicator shows more information about the current
|
|
||||||
cursor positions, including the length of the selection for selected text.
|
|
||||||
|
|
||||||
\image qtcreator-editor-line-column.webp {Line and column indicator on the Edit mode toolbar}
|
|
||||||
|
|
||||||
\note You can also use the \l{Show and hide sidebars}{sidebars} to
|
|
||||||
move around in \QC.
|
|
||||||
|
|
||||||
\section2 Selecting Parse Context
|
|
||||||
|
|
||||||
Code might be interpreted differently in different contexts. A file can be
|
|
||||||
used by different projects or subprojects with different defines, or it can
|
|
||||||
be included in the context of C, C++, Objective-C, or Objective-C++. To
|
|
||||||
change the active parse context, select an available parse context in the
|
|
||||||
\uicontrol {Active Parse Context} menu (4). The menu is visible only when
|
|
||||||
several parse contexts are available. To reset the parse context,
|
|
||||||
right-click on the menu to open a context menu, and then select
|
|
||||||
\uicontrol {Clear Preferred Parse Context}.
|
|
||||||
If the information needed for parsing the project is still incomplete or
|
|
||||||
incorrect, select \uicontrol {Additional Preprocessor Directives} to
|
|
||||||
add preprocessor directives.
|
|
||||||
|
|
||||||
\section2 Changing Text Encoding
|
|
||||||
|
|
||||||
To show the file encoding of the current file on the editor toolbar (5),
|
|
||||||
select \preferences > \uicontrol {Text Editor} >
|
|
||||||
\uicontrol Display > \uicontrol {Display file encoding}.
|
|
||||||
|
|
||||||
To change the text encoding, click it on the toolbar and select new
|
|
||||||
encoding in the \uicontrol {Text Encoding} dialog:
|
|
||||||
|
|
||||||
\image qtcreator-text-encoding.png "Text Encoding dialog"
|
|
||||||
|
|
||||||
To reload the file with the selected encoding, select
|
|
||||||
\uicontrol {Reload with Encoding}. To save the file with
|
|
||||||
the new encoding, select \uicontrol {Save with Encoding}.
|
|
||||||
|
|
||||||
\section2 Selecting Line Ending Style
|
|
||||||
|
|
||||||
To switch between Windows line endings (CRLF) and Unix line endings (LF),
|
|
||||||
select the ending style on the editor toolbar (6). To hide this field,
|
|
||||||
select \preferences > \uicontrol {Text Editor}
|
|
||||||
> \uicontrol Display, and deselect \uicontrol {Display file line ending}.
|
|
||||||
|
|
||||||
To set the line endings to use for all projects by default, select
|
|
||||||
\preferences > \uicontrol {Text Editor} >
|
|
||||||
\uicontrol Behavior, and then select the ending style in the
|
|
||||||
\uicontrol {Default line endings} field.
|
|
||||||
|
|
||||||
To set the line endings to use for a project, select \uicontrol Projects >
|
|
||||||
\uicontrol {Project Settings} > \uicontrol Editor.
|
|
||||||
|
|
||||||
For more information, see \l {Specify editor settings}.
|
|
||||||
|
|
||||||
\section2 Managing Language Servers
|
|
||||||
|
|
||||||
Select the \inlineimage icons/languageclient.png
|
|
||||||
icon on the editor toolbar (7) to view the \l{Language Servers}
|
|
||||||
{language server} for the current project. You can restart the language
|
|
||||||
server or select another one in the menu. Also, you can
|
|
||||||
\l{Inspect language clients}{inspect the communication} between \QC
|
|
||||||
and language servers and view server capabilities, as well as
|
|
||||||
set language server preferences.
|
|
||||||
|
|
||||||
\sa {Manage Language Servers}{How To: Manage Language Servers}
|
|
||||||
|
|
||||||
\section1 Editing Selected Lines
|
\section1 Editing Selected Lines
|
||||||
|
|
||||||
The \uicontrol Edit > \uicontrol Advanced menu has options for editing
|
In the \uicontrol Edit mode go to \uicontrol Edit > \uicontrol Advanced
|
||||||
selected lines of text.
|
to edit lines of text that you select in the editor:
|
||||||
|
|
||||||
To duplicate the selected lines, select \uicontrol {Duplicate Selection}.
|
\list
|
||||||
To format the duplicated lines as a comment, select
|
\li To duplicate the selected lines, go to
|
||||||
\uicontrol {Duplicate Selection and Comment}.
|
\uicontrol {Duplicate Selection}.
|
||||||
|
\li To format the duplicated lines as a comment, go to
|
||||||
|
\uicontrol {Duplicate Selection and Comment}.
|
||||||
|
\li To turn selected text into lowercase, go to
|
||||||
|
\uicontrol {Lowercase Selection} or press \key {Alt+U}.
|
||||||
|
\li To turn selected text into uppercase, go to
|
||||||
|
\uicontrol {Uppercase Selection} or press \key {Alt+Shift+U}.
|
||||||
|
\li To sort selected lines alphabetically, go to
|
||||||
|
\uicontrol {Sort Selected Lines} or press \key {Alt+Shift+S}.
|
||||||
|
\li To add a cursor at the next occurrence of selected text for multi-cursor
|
||||||
|
editing, go to \uicontrol {Add Next Occurrence to Selection} or press \key {Ctrl+D}
|
||||||
|
\endlist
|
||||||
|
|
||||||
To turn selected text into lowercase, select \uicontrol {Lowercase Selection}
|
\sa {Edit Code}{How To: Edit Code},
|
||||||
or press \key {Alt+U}. To turn it into uppercase, select
|
{Manage Language Servers}{How To: Manage Language Servers}, {File System},
|
||||||
\uicontrol {Uppercase Selection} or press \key {Alt+Shift+U}.
|
{Projects}
|
||||||
|
*/
|
||||||
|
|
||||||
To sort selected lines alphabetically, select \uicontrol {Sort Selected Lines}
|
/*!
|
||||||
or press \key {Alt+Shift+S}.
|
\page creator-how-to-move-between-open-files.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
Select \uicontrol {Add Next Occurrence to Selection} or press \key {Ctrl+D}
|
\ingroup creator-how-to-edit
|
||||||
to add a cursor at the next occurrence of selected text for multi-cursor
|
|
||||||
editing.
|
|
||||||
|
|
||||||
\section1 Multi-Cursor Editing
|
\title Move between open files
|
||||||
|
|
||||||
To apply a change to several places simultaneously, press and hold \key Alt,
|
Use the \l{Edit Mode}{editor toolbar}, \uicontrol Window menu items, or
|
||||||
and click to place cursors in several places. Any changes you make are
|
\l{General Keyboard Shortcuts}{keyboard shortcuts} to move between open
|
||||||
applied simultaneously at all the cursor positions.
|
files.
|
||||||
|
|
||||||
Use the arrow keys to move all the cursors up and down. The \key Home and
|
To go to any open file, select it in the list of open files (1) on the editor
|
||||||
\key End key move all the cursors to the beginning or to the end of the
|
toolbar.
|
||||||
line.
|
|
||||||
|
|
||||||
Press and hold \key Alt and double-click strings to select several strings
|
\image qtcreator-editor-open-files.webp {List of open files on Edit mode toolbar}
|
||||||
simultaneously.
|
|
||||||
|
|
||||||
Press \key {Alt+Shift+I} to create cursors at the ends of selected lines.
|
To browse backward or forward through your location history, click
|
||||||
|
\inlineimage icons/prev.png (\uicontrol {Go Back}) and
|
||||||
|
\inlineimage icons/next.png (\uicontrol {Go Forward}) on the editor toolbar.
|
||||||
|
|
||||||
Press \key Esc to remove all the cursors and selections.
|
To return to the last location where you made a change, go to
|
||||||
|
\uicontrol Window > \uicontrol {Go to Last Edit}.
|
||||||
|
|
||||||
\section1 Splitting the Editor View
|
Use keyboard shortcuts:
|
||||||
|
|
||||||
Split the editor view or open the editor in a new window when you want to
|
\list
|
||||||
work on and view multiple files on the same screen or on multiple screens.
|
\li To quickly move between currently open files, press \key Ctrl+Tab.
|
||||||
|
\li To move forward in the location history, press \key {Alt+Right}
|
||||||
|
(\key {Cmd+Opt+Right} on \macos).
|
||||||
|
\li To move backward, press \key {Alt+Left} (\key {Cmd+Opt+Left} on \macos).
|
||||||
|
For example, after you use the \uicontrol Locator
|
||||||
|
to jump to a symbol in the same file, press \key {Alt+Left} to jump
|
||||||
|
back to your original location in that file.
|
||||||
|
\endlist
|
||||||
|
|
||||||
\image qtcreator-spliteditorview.png
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}, {File System}, {Projects}
|
||||||
|
*/
|
||||||
|
|
||||||
You can view multiple files simultaneously in the following ways:
|
/*!
|
||||||
|
\page creator-how-to-move-to-symbols.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-edit
|
||||||
|
|
||||||
|
\title Move to symbols
|
||||||
|
|
||||||
|
Use the \l{Edit Mode}{editor toolbar}, locator, \uicontrol Window menu items,
|
||||||
|
or \l{General Keyboard Shortcuts}{keyboard shortcuts} to navigate between
|
||||||
|
symbols in open files.
|
||||||
|
|
||||||
|
To jump to a symbol used in a project, select the symbol on the
|
||||||
|
editor toolbar (1).
|
||||||
|
|
||||||
|
\image qtcreator-editor-symbols.webp {List of symbols on Edit mode toolbar}
|
||||||
|
|
||||||
|
By default, the symbols are displayed in the order in which they appear in
|
||||||
|
the file. Right-click the field and go to \uicontrol {Sort Alphabetically}
|
||||||
|
to arrange the symbols in alphabetic order.
|
||||||
|
|
||||||
|
\section1 Locate symbols
|
||||||
|
|
||||||
|
To jump to a symbol in the current file, activate the locator,
|
||||||
|
enter a period (.) or colon (:), and start typing the symbol name. Then
|
||||||
|
select the symbol in the list.
|
||||||
|
|
||||||
|
For example, to locate symbols matching \c {QGuiApplication}:
|
||||||
|
|
||||||
|
\list 1
|
||||||
|
|
||||||
|
\li Press \key {Ctrl+K} to activate the locator.
|
||||||
|
|
||||||
|
\li Enter a colon (:) followed by a space and the upper case letters in
|
||||||
|
the symbol name (here, \c {QGuiApplication}):
|
||||||
|
|
||||||
|
\code
|
||||||
|
: qga
|
||||||
|
\endcode
|
||||||
|
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
The locator lists the results.
|
||||||
|
|
||||||
|
\image qtcreator-locator-example.webp {List of files matching the locator filter}
|
||||||
|
|
||||||
|
Filters locating class and function definitions also accept namespaces,
|
||||||
|
such as \c {Utils::*View}.
|
||||||
|
|
||||||
|
\section1 Move to symbol definition or declaration
|
||||||
|
|
||||||
|
To move directly to the definition or declaration of a symbol in the
|
||||||
|
\uicontrol Edit mode, move the cursor on the symbol and press \key {F2}.
|
||||||
|
|
||||||
|
Or, hold the \key Ctrl key (\key Cmd on \macos) and click
|
||||||
|
the symbol. If you have multiple splits opened, open the link in the next
|
||||||
|
split by holding \key Ctrl and \key Alt while clicking the symbol.
|
||||||
|
|
||||||
|
To enable this moving function, go to \preferences > \uicontrol {Text Editor}
|
||||||
|
> \uicontrol Behavior > \uicontrol {Enable mouse navigation}.
|
||||||
|
|
||||||
|
\image qtcreator-preferences-texteditor-behavior.webp {Text Editor Behavior preferences}
|
||||||
|
|
||||||
|
\section2 Follow symbols
|
||||||
|
|
||||||
|
Go to the context menu or to \uicontrol Tools > \uicontrol C++ or
|
||||||
|
\uicontrol QML/JS for more ways to move to the definition or declaration
|
||||||
|
of a symbol in the current split or the next split:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li To follow namespaces, classes, functions, variables, include
|
||||||
|
statements, and macros, go to \uicontrol {Follow Symbol Under Cursor}
|
||||||
|
or \uicontrol {Follow Symbol Under Cursor in Next Split}.
|
||||||
|
\li To move to the type definition of a symbol, go to
|
||||||
|
\uicontrol {Follow Symbol Under Cursor to Type} (\key {Ctrl+Shift+F2})
|
||||||
|
or \uicontrol {Follow Symbol Under Cursor to Type in Next Split}
|
||||||
|
(\key {Ctrl+E, Ctrl+Shift+F2}).
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\section2 Switch between function definition and decalaration
|
||||||
|
|
||||||
|
To switch between the definition and declaration of a function, place the
|
||||||
|
cursor on either and press \key {Shift+F2} or right-click and go to
|
||||||
|
\uicontrol {Switch Between Function Declaration/Definition} or
|
||||||
|
\uicontrol {Open Function Declaration/Definition in Next Split}.
|
||||||
|
For example, this allows you to navigate from anywhere within a function
|
||||||
|
body directly to the function declaration.
|
||||||
|
|
||||||
|
To switch between C++ header and source files, right-click anywhere in a
|
||||||
|
file and go to \uicontrol {Switch Header/Source} (\key F4) or
|
||||||
|
\uicontrol {Open Corresponding Header/Source in Next Split}
|
||||||
|
(\key {Ctrl+E,F4}).
|
||||||
|
|
||||||
|
\section2 Open links in another split
|
||||||
|
|
||||||
|
Links open in the same split by default. To open them in the next
|
||||||
|
split, press \key {Ctrl+E} first. For example, press \key {Ctrl+E,F2} to
|
||||||
|
follow the symbol into the next split. If necessary, the view is
|
||||||
|
automatically split.
|
||||||
|
|
||||||
|
To change the default behavior, go to \preferences >
|
||||||
|
\uicontrol {Text Editor} > \uicontrol Display and select
|
||||||
|
\uicontrol {Always open links in another split}. The symbol,
|
||||||
|
definition, or declaration opens in another split. Also, the
|
||||||
|
shortcuts for opening link targets in the next split are used
|
||||||
|
to open them in the current split.
|
||||||
|
|
||||||
|
\image qtcreator-options-text-editor-display.png {Text Editor Display preferences}
|
||||||
|
|
||||||
|
\section1 Open resource files for editing
|
||||||
|
|
||||||
|
When the cursor is on a string literal and the string is a Qt resource file
|
||||||
|
(.qrc) path, following the symbol opens the specified resource file for
|
||||||
|
editing in the \uicontrol {Resource Browser}.
|
||||||
|
|
||||||
|
\image qtcreator-add-resource.png {Resource Browser}
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}, {Editing Keyboard Shortcuts},
|
||||||
|
{Searching with the Locator}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-change-text-encoding.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-configure-editors
|
||||||
|
|
||||||
|
\title Change text encoding
|
||||||
|
|
||||||
|
\image qtcreator-editor-toolbar.webp {Edit mode toolbar}
|
||||||
|
|
||||||
|
To show the file encoding of the current file on the editor toolbar (4) in
|
||||||
|
the \uicontrol Edit mode, go to \preferences > \uicontrol {Text Editor} >
|
||||||
|
\uicontrol Display > \uicontrol {Display file encoding}.
|
||||||
|
|
||||||
|
\image qtcreator-options-text-editor-display.png {Text Editor Display preferences}
|
||||||
|
|
||||||
|
To change the text encoding, select it on the toolbar, and then select new
|
||||||
|
encoding in the \uicontrol {Text Encoding} dialog:
|
||||||
|
|
||||||
|
\image qtcreator-text-encoding.png {Text Encoding dialog}
|
||||||
|
|
||||||
|
To reload the file with the selected encoding, select
|
||||||
|
\uicontrol {Reload with Encoding}.
|
||||||
|
|
||||||
|
To save the file with the new encoding, go to
|
||||||
|
\uicontrol {Save with Encoding}.
|
||||||
|
|
||||||
|
\section1 Set default encoding
|
||||||
|
|
||||||
|
To define the default file encoding, select \preferences >
|
||||||
|
\uicontrol {Text Editor} > \uicontrol Behavior, and
|
||||||
|
then select a suitable option in \uicontrol {Default encoding}.
|
||||||
|
|
||||||
|
\image qtcreator-options-texteditor-behavior-file-encodings.png {File encoding preferences}
|
||||||
|
|
||||||
|
Qt 5 and Qt 6 require UTF-8 encoded source files, and therefore the default
|
||||||
|
encoding is set to \uicontrol UTF-8.
|
||||||
|
Detecting the correct encoding is tricky, so \QC will not try to do so.
|
||||||
|
Instead, it displays the following error message when you try to edit a file
|
||||||
|
that is not UTF-8 encoded: \uicontrol {Error: Could not decode "filename" with
|
||||||
|
"UTF-8"-encoding. Editing not possible.}
|
||||||
|
|
||||||
|
To resolve the issue, use a file conversion tool to convert the file
|
||||||
|
encoding to UTF-8 when developing Qt 5 applications. Otherwise, conversion
|
||||||
|
of string constants to QString might not work as expected.
|
||||||
|
|
||||||
|
If you develop only Qt 4 applications or other than Qt applications, you
|
||||||
|
can set other encoding options as the default encoding. Select the
|
||||||
|
\uicontrol System option to use the file encoding used by your system.
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}, {Behavior}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-select-line-endings.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-configure-editors
|
||||||
|
|
||||||
|
\title Select line ending style
|
||||||
|
|
||||||
|
To switch between Windows line endings (CRLF) and Unix line endings (LF),
|
||||||
|
select the ending style on the editor toolbar (3) in the \uicontrol Edit
|
||||||
|
mode.
|
||||||
|
|
||||||
|
\image qtcreator-editor-toolbar.webp {Edit mode toolbar}
|
||||||
|
|
||||||
|
To hide this field, go to \preferences > \uicontrol {Text Editor}
|
||||||
|
> \uicontrol Display, and clear \uicontrol {Display file line ending}.
|
||||||
|
|
||||||
|
\section1 Set default style
|
||||||
|
|
||||||
|
To set the line endings to use for all projects by default, go to
|
||||||
|
\preferences > \uicontrol {Text Editor} > \uicontrol Behavior and
|
||||||
|
select the ending style in \uicontrol {Default line endings}.
|
||||||
|
|
||||||
|
\image qtcreator-options-texteditor-behavior-file-encodings.png {Default file ending preferences}
|
||||||
|
|
||||||
|
To set the line endings to use for a project, go to \uicontrol Projects >
|
||||||
|
\uicontrol {Project Settings} > \uicontrol Editor.
|
||||||
|
|
||||||
|
\image qtcreator-editor-settings.webp {Editor settings for a project}
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Specify editor settings}, {Edit Mode}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-edit
|
||||||
|
|
||||||
|
\title Insert multiple cursors
|
||||||
|
|
||||||
|
To apply a change to several places simultaneously in the editor in the
|
||||||
|
\uicontrol Edit mode, press and hold \key Alt, and click to place cursors
|
||||||
|
in several places in the file. Any changes you make are applied
|
||||||
|
simultaneously at all the cursor positions.
|
||||||
|
|
||||||
|
\image qtcreator-editor-multicursor.webp {Multiple cursors in the editor}
|
||||||
|
|
||||||
|
To manage cursors:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li Press the arrow keys to move all the cursors up and down.
|
||||||
|
\li Press the \key Home and \key End key to move all the cursors
|
||||||
|
to the beginning or to the end of the line.
|
||||||
|
\li Press and hold \key Alt and double-click strings to select
|
||||||
|
several strings simultaneously.
|
||||||
|
\li Press \key {Alt+Shift+I} to create cursors at the ends of
|
||||||
|
selected lines.
|
||||||
|
\li Press \key Esc to remove all the cursors and selections.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Editing Selected Lines}, {Edit Mode}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-split-editor-views.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-edit
|
||||||
|
|
||||||
|
\title Split the editor view
|
||||||
|
|
||||||
|
Split the editor view or open the editor in a new window to work on
|
||||||
|
and view many files on the same screen or on many screens.
|
||||||
|
|
||||||
|
\image qtcreator-spliteditorview.png {Editor view split horizontally and vertically}
|
||||||
|
|
||||||
|
View many files at the same time:
|
||||||
|
|
||||||
\list
|
\list
|
||||||
|
|
||||||
\li To split the editor view into a top and bottom view, select
|
\li To split the editor view into a top and bottom view, go to
|
||||||
\uicontrol Window > \uicontrol Split, press \key {Ctrl+E, 2}, or
|
\uicontrol Window > \uicontrol Split, press \key {Ctrl+E, 2}, or
|
||||||
select the \inlineimage icons/splitbutton_horizontal.png
|
select the \inlineimage icons/splitbutton_horizontal.png
|
||||||
(\uicontrol Split) button and then select \uicontrol Split.
|
(\uicontrol Split) button and then select \uicontrol Split.
|
||||||
|
|
||||||
Split command creates views below the currently active editor view.
|
The \uicontrol Split command creates views below the currently active
|
||||||
|
editor view.
|
||||||
|
|
||||||
\li To split the editor view into adjacent views, select
|
\li To split the editor view into adjacent views, go to
|
||||||
\uicontrol Window > \uicontrol {Split Side by Side}, press
|
\uicontrol Window > \uicontrol {Split Side by Side}, press
|
||||||
\key {Ctrl+E, 3}, or select \uicontrol Split >
|
\key {Ctrl+E, 3}, or select \uicontrol Split >
|
||||||
\uicontrol {Split Side by Side}.
|
\uicontrol {Split Side by Side}.
|
||||||
|
|
||||||
Side by side split command creates views to the right of the
|
The \uicontrol {Split Side by Side} command creates views to the right
|
||||||
currently active editor view.
|
of the currently active editor view.
|
||||||
|
|
||||||
\li To open the editor in a detached window, press \key {Ctrl+E, 4}, or
|
\li To open the editor in a detached window, press \key {Ctrl+E, 4}, or
|
||||||
select \uicontrol Window > \uicontrol {Open in New Window}.
|
go to \uicontrol Window > \uicontrol {Open in New Window}.
|
||||||
|
|
||||||
The new window behaves basically in the same way as the editor area
|
The new window behaves in the same way as the editor area
|
||||||
in the main window. For example, you can split this window, as well.
|
in the main window. For example, you can split this window, as well.
|
||||||
Documents are opened in the currently active editor window.
|
Documents are opened in the currently active editor window.
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To move between split views and detached editor windows, select
|
\section1 Move between views and windows
|
||||||
|
|
||||||
|
To move between split views and detached editor windows, go to
|
||||||
\uicontrol Window > \uicontrol {Go to Next Split or Window} or press
|
\uicontrol Window > \uicontrol {Go to Next Split or Window} or press
|
||||||
\key {Ctrl+E, O}.
|
\key {Ctrl+E, O}.
|
||||||
|
|
||||||
To remove a split view, place the cursor within the view you want to
|
\section1 Remove splits
|
||||||
remove and select \uicontrol Window > \uicontrol {Remove Current Split},
|
|
||||||
press \key {Ctrl+E, 0}, or select the \inlineimage icons/splitbutton_closetop.png
|
|
||||||
(\uicontrol {Remove Split}) button. To remove all but the currently selected
|
|
||||||
split view, select \uicontrol Window > \uicontrol {Remove All Splits} or
|
|
||||||
press \key {Ctrl+E, 1}.
|
|
||||||
|
|
||||||
\section1 Using Bookmarks
|
To remove a split view:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li Place the cursor within the view you want to remove and go to
|
||||||
|
\uicontrol Window > \uicontrol {Remove Current Split}.
|
||||||
|
\li Press \key {Ctrl+E, 0}.
|
||||||
|
\li Select the \inlineimage icons/splitbutton_closetop.png
|
||||||
|
(\uicontrol {Remove Split}) button.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
To remove all but the currently selected split view:
|
||||||
|
|
||||||
|
\list
|
||||||
|
\li Go to \uicontrol Window > \uicontrol {Remove All Splits}.
|
||||||
|
\li Press \key {Ctrl+E, 1}.
|
||||||
|
\endlist
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Detach views}, {Edit Mode}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-use-bookmarks.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-edit
|
||||||
|
|
||||||
|
\title Bookmark code
|
||||||
|
|
||||||
To insert or delete a bookmark in the \uicontrol Edit mode:
|
To insert or delete a bookmark in the \uicontrol Edit mode:
|
||||||
|
|
||||||
@@ -221,31 +481,33 @@
|
|||||||
|
|
||||||
\image qtcreator-togglebookmark.png
|
\image qtcreator-togglebookmark.png
|
||||||
|
|
||||||
\section2 Adding Notes to Bookmarks
|
\section1 Add notes to bookmarks
|
||||||
|
|
||||||
To add a note to a bookmark:
|
To add a note to a bookmark:
|
||||||
|
|
||||||
\list
|
\list
|
||||||
\li Select \uicontrol Tools > \uicontrol Bookmarks >
|
\li Go to \uicontrol Tools > \uicontrol Bookmarks >
|
||||||
\uicontrol {Edit Bookmark}.
|
\uicontrol {Edit Bookmark}.
|
||||||
\li Press \key {Ctrl+Shift+M}.
|
\li Press \key {Ctrl+Shift+M}.
|
||||||
\li Right-click a bookmark and select \uicontrol {Edit Bookmark}
|
\li Right-click a bookmark and go to \uicontrol {Edit Bookmark}
|
||||||
in the context menu.
|
in the context menu.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To view the note, move the mouse pointer over the bookmark or open the
|
To view the note, move the mouse pointer over the bookmark or open the
|
||||||
\uicontrol Bookmarks view in the \l{Show and hide sidebars}{sidebar}.
|
\uicontrol Bookmarks view in the \l{Show and hide sidebars}{sidebar}.
|
||||||
|
|
||||||
\section2 Navigating Bookmarks
|
\section1 Navigate bookmarks
|
||||||
|
|
||||||
To go to the previous bookmark in the current session, select
|
To move to the previous bookmark in the current session, go to
|
||||||
\uicontrol Tools > \uicontrol Bookmarks > \uicontrol {Previous Bookmark}
|
\uicontrol Tools > \uicontrol Bookmarks > \uicontrol {Previous Bookmark}
|
||||||
or press \key {Ctrl+,}.
|
or press \key {Ctrl+,}.
|
||||||
|
|
||||||
To go to the next bookmark in the current session, select \uicontrol Tools >
|
To move to the next bookmark in the current session, go to \uicontrol Tools >
|
||||||
\uicontrol Bookmarks > \uicontrol {Previous Bookmark} or press
|
\uicontrol Bookmarks > \uicontrol {Previous Bookmark} or press
|
||||||
\key {Ctrl+.}.
|
\key {Ctrl+.}.
|
||||||
|
|
||||||
|
\section2 Locate bookmarks
|
||||||
|
|
||||||
To use the locator to go to a bookmark, press \key {Ctrl+K} (or \key {Cmd+K}
|
To use the locator to go to a bookmark, press \key {Ctrl+K} (or \key {Cmd+K}
|
||||||
on \macos) to open the locator. Enter \e b and a space to display a list of
|
on \macos) to open the locator. Enter \e b and a space to display a list of
|
||||||
bookmarks. To filter the bookmarks by line number or a text string, enter
|
bookmarks. To filter the bookmarks by line number or a text string, enter
|
||||||
@@ -254,80 +516,66 @@
|
|||||||
|
|
||||||
\image qtcreator-locator-bookmark-filtering.png "Filtering bookmarks in locator"
|
\image qtcreator-locator-bookmark-filtering.png "Filtering bookmarks in locator"
|
||||||
|
|
||||||
\section2 Viewing Bookmarks
|
\section1 View bookmarks
|
||||||
|
|
||||||
Bookmarks are listed in the \uicontrol Bookmarks view in the sidebar. To
|
The \uicontrol Bookmarks view in the sidebar lists bookmarks. To
|
||||||
move between bookmarks, select the \uicontrol {Previous Bookmark} or
|
move between bookmarks, select the \uicontrol {Previous Bookmark} or
|
||||||
\uicontrol {Next Bookmark} button or use the keyboard shortcuts.
|
\uicontrol {Next Bookmark} button or use the keyboard shortcuts.
|
||||||
|
|
||||||
\image qtcreator-bookmarks-view.png "Listing bookmarks in Bookmarks view"
|
\image qtcreator-bookmarks-view.png "Listing bookmarks in Bookmarks view"
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
|
*/
|
||||||
|
|
||||||
\section1 Moving to Symbol Definition or Declaration
|
/*!
|
||||||
|
\page creator-how-to-reparse-files.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
You can move directly to the definition or the declaration of a symbol
|
\ingroup creator-how-to-edit
|
||||||
in the \uicontrol Edit mode by
|
|
||||||
holding the \key Ctrl key and clicking the symbol. If you have multiple
|
|
||||||
splits opened, you can open the link in the next split by holding \key Ctrl
|
|
||||||
and \key Alt while clicking the symbol.
|
|
||||||
|
|
||||||
To enable this moving function, select \preferences > \uicontrol {Text Editor}
|
\title Parse files
|
||||||
> \uicontrol Behavior > \uicontrol {Enable mouse navigation}.
|
|
||||||
|
|
||||||
There are several additional ways of moving between symbol definitions and
|
When you open a project, \QC parses the source files in the project and
|
||||||
declarations. All the functions described below are also available from the
|
performs a semantic analysis to build up the information that it needs for
|
||||||
\uicontrol Tools > \uicontrol C++ menu. The functions supported for QML and
|
code editing services, such as navigation and finding usages.
|
||||||
JavaScript code are available from the \uicontrol Tools > \uicontrol QML/JS
|
|
||||||
menu.
|
|
||||||
|
|
||||||
You can select the symbol and press \key F2, or right-click the symbol
|
\section1 Select parse context
|
||||||
and select \uicontrol {Follow Symbol Under Cursor} to move to its definition
|
|
||||||
or declaration. To follow the symbol in the next split, select
|
|
||||||
\uicontrol {Follow Symbol Under Cursor in Next Split}. Following symbols is
|
|
||||||
supported for namespaces, classes, functions, variables, include statements,
|
|
||||||
and macros.
|
|
||||||
|
|
||||||
To move to the type definition of a symbol, select
|
Code might be interpreted differently in different contexts. A file can be
|
||||||
\uicontrol {Follow Symbol Under Cursor to Type} or press
|
used by different projects or subprojects with different defines, or it can
|
||||||
\key {Ctrl+Shift+F2}. To follow the symbol in the next split, select
|
be included in the context of C, C++, Objective-C, or Objective-C++.
|
||||||
\uicontrol {Follow Symbol Under Cursor to Type in Next Split} or
|
|
||||||
press \key {Ctrl+E, Ctrl+Shift+F2}.
|
|
||||||
|
|
||||||
When the cursor is on a string literal and the string is a QRC file path,
|
To change the active parse context, select an available parse context on the
|
||||||
following the symbol opens the specified resource file for editing in the
|
\uicontrol Edit mode toolbar in \uicontrol #. The button is visible only when
|
||||||
\uicontrol {Resource Browser}.
|
several parse contexts are available.
|
||||||
|
|
||||||
To switch between the definition and declaration of a function, place the
|
\image qtcreator-editor-open-files.webp {Edit mode toolbar}
|
||||||
cursor on either and press \key {Shift+F2} or right-click and select
|
|
||||||
\uicontrol {Switch Between Function Declaration/Definition} or
|
|
||||||
\uicontrol {Open Function Declaration/Definition in Next Split}.
|
|
||||||
For example, this allows you to navigate from anywhere within a function
|
|
||||||
body directly to the function declaration.
|
|
||||||
|
|
||||||
Links are opened in the same split by default. To open links in the next
|
To reset the parse context, go to \uicontrol # >
|
||||||
split, prepend \key {Ctrl+E} to the shortcut. For example, press
|
\uicontrol {Clear Preferred Parse Context}.
|
||||||
\key {Ctrl+E,F2} to follow the symbol in the next split. If necessary, the
|
|
||||||
view is automatically split. To change the default behavior, select
|
|
||||||
\preferences > \uicontrol {Text Editor} > \uicontrol Display >
|
|
||||||
\uicontrol {Always open links in another split}.
|
|
||||||
Additional symbols are
|
|
||||||
displayed and switching between definition and declaration is done in
|
|
||||||
another split. If you change the default behavior, the shortcuts for opening
|
|
||||||
link targets in the next split are used to open them in the current split.
|
|
||||||
|
|
||||||
To switch between C++ header and source files, right-click anywhere in a
|
If the information needed for parsing the project is still incomplete or
|
||||||
file and select \uicontrol {Switch Header/Source} or
|
incorrect, go to \uicontrol {Additional Preprocessor Directives} to
|
||||||
\uicontrol {Open Corresponding Header/Source in Next Split}. You can also
|
add preprocessor directives.
|
||||||
press \key F4 or \key {Ctrl+E,F4}, respectively.
|
|
||||||
|
|
||||||
\section1 Reparsing Externally Changed Files
|
\section1 Reparse externally changed files
|
||||||
|
|
||||||
If source files are modified from outside \QC, the opened files will be
|
If source files are modified from outside \QC, the open files (1) are
|
||||||
reparsed automatically. For all other files, you can use \uicontrol Tools >
|
reparsed automatically. To update other files, go to \uicontrol Tools >
|
||||||
\uicontrol {C++} > \uicontrol {Reparse Externally Changed Files} to update
|
\uicontrol {C++} > \uicontrol {Reparse Externally Changed Files} to update
|
||||||
the code model.
|
the code model.
|
||||||
|
|
||||||
\section1 Inspecting the Code Model
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}, {Clang Code Model},
|
||||||
|
{Code Model}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\page creator-how-to-inspect-code-model.html
|
||||||
|
\previouspage creator-how-tos.html
|
||||||
|
|
||||||
|
\ingroup creator-how-to-edit
|
||||||
|
|
||||||
|
\title Inspect the code model
|
||||||
|
|
||||||
When you \l{https://bugreports.qt.io/}{report a bug} that is related to the
|
When you \l{https://bugreports.qt.io/}{report a bug} that is related to the
|
||||||
C++ code model, the \QC developers might ask you to write information about
|
C++ code model, the \QC developers might ask you to write information about
|
||||||
@@ -339,11 +587,15 @@
|
|||||||
select \uicontrol Tools > \uicontrol {Debug \QC } >
|
select \uicontrol Tools > \uicontrol {Debug \QC } >
|
||||||
\uicontrol {Inspect C++ Code Model} or press \key {Ctrl+Shift+F12}.
|
\uicontrol {Inspect C++ Code Model} or press \key {Ctrl+Shift+F12}.
|
||||||
|
|
||||||
|
\image qtcreator-code-model-inspector.webp {Code Model Inspector dialog}
|
||||||
|
|
||||||
\QC generates the code model inspection log file in a temporary folder.
|
\QC generates the code model inspection log file in a temporary folder.
|
||||||
|
|
||||||
\QC underlines semantic errors in olive in the C++ code editor. To check the
|
\QC underlines semantic errors in olive in the C++ code editor in the
|
||||||
correct paths for includes that are not resolved or that are resolved to the
|
\uicontrol Edit mode. To check the correct paths for includes that are not
|
||||||
wrong file, select \uicontrol {Project Parts} > \uicontrol {Header Paths}.
|
resolved or that are resolved to the wrong file,
|
||||||
|
go to \uicontrol {Project Parts} > \uicontrol {Header Paths}.
|
||||||
|
|
||||||
\sa {Detach views}
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}, {Clang Code Model},
|
||||||
|
{Code Model}
|
||||||
*/
|
*/
|
||||||
|
@@ -70,7 +70,7 @@
|
|||||||
|
|
||||||
\section1 Receiving Suggestions
|
\section1 Receiving Suggestions
|
||||||
|
|
||||||
When you write code in the \l {Working in Edit Mode}{Edit} mode and
|
When you write code in the \l {Edit Mode}{Edit} mode and
|
||||||
\uicontrol {Auto request} is enabled, Copilot automatically makes
|
\uicontrol {Auto request} is enabled, Copilot automatically makes
|
||||||
suggestions when you type.
|
suggestions when you type.
|
||||||
|
|
||||||
|
@@ -30,11 +30,11 @@
|
|||||||
\l{https://github.com/microsoft/vscode-languageserver-node/pull/367}
|
\l{https://github.com/microsoft/vscode-languageserver-node/pull/367}
|
||||||
{Proposal of the semantic highlighting protocol extension}
|
{Proposal of the semantic highlighting protocol extension}
|
||||||
\li Navigating in the code by using the \l{Searching with the Locator}
|
\li Navigating in the code by using the \l{Searching with the Locator}
|
||||||
{locator} or \l{Moving to Symbol Definition or Declaration}
|
{locator} or \l{Move to symbol definition or declaration}
|
||||||
{moving to the symbol definition}
|
{moving to the symbol definition}
|
||||||
\li Inspecting code by viewing the document outline in the
|
\li Inspecting code by viewing the document outline in the
|
||||||
\l{Outline} view or in the \uicontrol Symbols list on the
|
\l{Outline} view or in the \uicontrol Symbols list on the
|
||||||
\l{Using the Editor Toolbar}{editor toolbar}
|
\l{Edit Mode}{editor toolbar}
|
||||||
\li \l{Call Hierarchy}{Viewing the callers and callees of a function}
|
\li \l{Call Hierarchy}{Viewing the callers and callees of a function}
|
||||||
\li \l{Finding Symbols}{Finding references to symbols}
|
\li \l{Finding Symbols}{Finding references to symbols}
|
||||||
\li \l{Renaming Symbols}{Renaming the symbol under cursor}
|
\li \l{Renaming Symbols}{Renaming the symbol under cursor}
|
||||||
@@ -264,8 +264,8 @@
|
|||||||
For a generic language server, the value of the \uicontrol {Startup behavior}
|
For a generic language server, the value of the \uicontrol {Startup behavior}
|
||||||
field in the \l{Add generic language servers}{language server preferences}
|
field in the \l{Add generic language servers}{language server preferences}
|
||||||
determines when the server is started. To restart language servers, select
|
determines when the server is started. To restart language servers, select
|
||||||
\inlineimage icons/languageclient.png on the \l{Managing Language Servers}
|
\inlineimage icons/languageclient.png on the \l{Edit Mode}{editor toolbar},
|
||||||
{editor toolbar}, and go to \uicontrol {Restart}.
|
and go to \uicontrol {Restart}.
|
||||||
|
|
||||||
\uicontrol Log displays additional information about the selected log entry.
|
\uicontrol Log displays additional information about the selected log entry.
|
||||||
You can see the \uicontrol {Content length} and \uicontrol {MIME type} of
|
You can see the \uicontrol {Content length} and \uicontrol {MIME type} of
|
||||||
|
@@ -95,31 +95,8 @@
|
|||||||
always place them there. Select \uicontrol {At Line Start} to place single
|
always place them there. Select \uicontrol {At Line Start} to place single
|
||||||
line comments at the end of the line.
|
line comments at the end of the line.
|
||||||
|
|
||||||
\section1 File Encoding
|
|
||||||
|
|
||||||
To define the default file encoding, select \preferences >
|
|
||||||
\uicontrol {Text Editor} > \uicontrol Behavior, and
|
|
||||||
then select a suitable option in \uicontrol {Default encoding}.
|
|
||||||
|
|
||||||
\image qtcreator-options-texteditor-behavior-file-encodings.png "File encoding preferences"
|
|
||||||
|
|
||||||
Qt 5 and Qt 6 require UTF-8 encoded source files, and therefore the default
|
|
||||||
encoding is set to \uicontrol UTF-8.
|
|
||||||
Detecting the correct encoding is tricky, so \QC will not try to do so.
|
|
||||||
Instead, it displays the following error message when you try to edit a file
|
|
||||||
that is not UTF-8 encoded: \uicontrol {Error: Could not decode "filename" with
|
|
||||||
"UTF-8"-encoding. Editing not possible.}
|
|
||||||
|
|
||||||
To resolve the issue, use a file conversion tool to convert the file
|
|
||||||
encoding to UTF-8 when developing Qt 5 applications. Otherwise, conversion
|
|
||||||
of string constants to QString might not work as expected.
|
|
||||||
|
|
||||||
If you develop only Qt 4 applications or other than Qt applications, you
|
|
||||||
can set other encoding options as the default encoding. Select the
|
|
||||||
\uicontrol System option to use the file encoding used by your system.
|
|
||||||
|
|
||||||
\if defined(qtcreator)
|
\if defined(qtcreator)
|
||||||
\sa {Find preferences}, {C++ Code Style}, {Nim}
|
\sa {Change text encoding}, {Find preferences}, {C++ Code Style}, {Nim}
|
||||||
\endif
|
\endif
|
||||||
|
|
||||||
\sa {Indent text or code}, {Qt Quick Code Style}, {Font & Colors}
|
\sa {Indent text or code}, {Qt Quick Code Style}, {Font & Colors}
|
||||||
|
@@ -98,26 +98,6 @@
|
|||||||
\generatelist creator-how-to-ui
|
\generatelist creator-how-to-ui
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\page creator-how-to-move-between-open-files.html
|
|
||||||
\previouspage creator-how-tos.html
|
|
||||||
|
|
||||||
\ingroup creator-how-to-edit
|
|
||||||
|
|
||||||
\title Move between open files
|
|
||||||
|
|
||||||
To quickly move between currently open files, press
|
|
||||||
\key Ctrl+Tab.
|
|
||||||
|
|
||||||
To move forward in the location history, press \key {Alt+Right}
|
|
||||||
(\key {Cmd+Opt+Right} on \macos).
|
|
||||||
|
|
||||||
To move backward, press \key {Alt+Left} (\key {Cmd+Opt+Left} on \macos).
|
|
||||||
For example, if you use the \uicontrol Locator
|
|
||||||
to jump to a symbol in the same file, you can jump back to your original
|
|
||||||
location in that file by pressing \key {Alt+Left}.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page creator-how-to-switch-to-edit-mode.html
|
\page creator-how-to-switch-to-edit-mode.html
|
||||||
\previouspage creator-how-tos.html
|
\previouspage creator-how-tos.html
|
||||||
@@ -138,6 +118,8 @@
|
|||||||
\li The second press closes secondary windows
|
\li The second press closes secondary windows
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -199,29 +181,6 @@
|
|||||||
\sa {Command-Line Options}
|
\sa {Command-Line Options}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
\page creator-how-to-move-to-symbols.html
|
|
||||||
\previouspage creator-how-tos.html
|
|
||||||
|
|
||||||
\ingroup creator-how-to-edit
|
|
||||||
|
|
||||||
\title Move to symbols
|
|
||||||
|
|
||||||
To move straight to a symbol used in a project, select the symbol in the
|
|
||||||
\uicontrol Editor toolbar drop-down menu. For more information on the editor
|
|
||||||
toolbar, see \l {Using the Editor Toolbar}.
|
|
||||||
|
|
||||||
To jump to a symbol in the current file, press \key {Ctrl+K} to open the
|
|
||||||
\uicontrol Locator, enter a period (.), and start typing the symbol name. Then
|
|
||||||
select the symbol in the list. For more information on using the locator,
|
|
||||||
see \l{Searching with the Locator}.
|
|
||||||
|
|
||||||
Press \key Ctrl (\key Cmd on \macos) and click a symbol to move directly to
|
|
||||||
the definition or the declaration of the symbol. You can also move the
|
|
||||||
cursor on the symbol and press \key {F2}. For more information, see
|
|
||||||
\l{Moving to Symbol Definition or Declaration}.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\page creator-how-to-locate-files-using-keyboard.html
|
\page creator-how-to-locate-files-using-keyboard.html
|
||||||
\previouspage creator-how-tos.html
|
\previouspage creator-how-tos.html
|
||||||
@@ -244,7 +203,7 @@
|
|||||||
|
|
||||||
\image qtcreator-locator-customize.webp "Locator preferences"
|
\image qtcreator-locator-customize.webp "Locator preferences"
|
||||||
|
|
||||||
For more information, see \l{Creating Locator Filters}.
|
\sa {Creating Locator Filters}, {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -261,7 +220,7 @@
|
|||||||
|
|
||||||
\image qtcreator-locator.webp "List of locator filters"
|
\image qtcreator-locator.webp "List of locator filters"
|
||||||
|
|
||||||
For more information, see \l{Executing JavaScript}.
|
\sa {Executing JavaScript}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -274,6 +233,8 @@
|
|||||||
|
|
||||||
Open the \uicontrol Locator with \key {Ctrl+K} and type m, followed by a space.
|
Open the \uicontrol Locator with \key {Ctrl+K} and type m, followed by a space.
|
||||||
You can now go directly to any QML method in the file.
|
You can now go directly to any QML method in the file.
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -317,19 +278,8 @@
|
|||||||
\QC stores copied text in clipboard history. To retrieve clips from the
|
\QC stores copied text in clipboard history. To retrieve clips from the
|
||||||
history, press \key {Ctrl+Shift+V} until the clip appears.
|
history, press \key {Ctrl+Shift+V} until the clip appears.
|
||||||
The number of clips in the history is fixed to 10.
|
The number of clips in the history is fixed to 10.
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
\page creator-how-to-sort-lines-alphabetically.html
|
|
||||||
\previouspage creator-how-tos.html
|
|
||||||
|
|
||||||
\ingroup creator-how-to-edit
|
|
||||||
|
|
||||||
\title Sort lines alphabetically
|
|
||||||
|
|
||||||
To sort selected lines alphabetically, select \uicontrol Edit >
|
|
||||||
\uicontrol Advanced > \uicontrol {Sort Selected Lines} or press
|
|
||||||
\key {Alt+Shift+S} (or \key Ctrl+Shift+S on \macos).
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -355,7 +305,7 @@
|
|||||||
|
|
||||||
\image qtcreator-preferences-texteditor-completion.webp "Completion preferences"
|
\image qtcreator-preferences-texteditor-completion.webp "Completion preferences"
|
||||||
|
|
||||||
\sa {Completion}
|
\sa {Completion}, {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -367,6 +317,8 @@
|
|||||||
\title Select the enclosing block in C++
|
\title Select the enclosing block in C++
|
||||||
|
|
||||||
Press \key {Ctrl+U}.
|
Press \key {Ctrl+U}.
|
||||||
|
|
||||||
|
\sa {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@@ -448,5 +400,5 @@
|
|||||||
\li Press \uicontrol Replace to replace all instances of the text.
|
\li Press \uicontrol Replace to replace all instances of the text.
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
For more information, see \l {Advanced Search}.
|
\sa {Advanced Search}, {Edit Code}{How To: Edit Code}, {Edit Mode}
|
||||||
*/
|
*/
|
||||||
|
@@ -36,8 +36,6 @@
|
|||||||
|
|
||||||
Click \uicontrol {Restore Global} to revert to the global settings.
|
Click \uicontrol {Restore Global} to revert to the global settings.
|
||||||
|
|
||||||
\sa {Configuring Fonts}, {File Encoding},
|
\sa {Configuring Fonts}, {Change text encoding}, {Indent text or code},
|
||||||
{Moving to Symbol Definition or Declaration}, {Indent text or code},
|
{View function tooltips}, {Text Editor}
|
||||||
{Edit MIME types}, {Selecting Line Ending Style},
|
|
||||||
{Semantic Highlighting}, {View function tooltips}
|
|
||||||
*/
|
*/
|
||||||
|
@@ -29,7 +29,6 @@
|
|||||||
\list
|
\list
|
||||||
\li \l{Writing Code}
|
\li \l{Writing Code}
|
||||||
\list
|
\list
|
||||||
\li \l{Working in Edit Mode}
|
|
||||||
\li \l{Semantic Highlighting}
|
\li \l{Semantic Highlighting}
|
||||||
\li \l{Checking Code Syntax}
|
\li \l{Checking Code Syntax}
|
||||||
\li \l{Using Qt Quick Toolbars}
|
\li \l{Using Qt Quick Toolbars}
|
||||||
|
@@ -18,7 +18,7 @@
|
|||||||
{states} and \l{Animation and Transitions in Qt Quick}{transitions}
|
{states} and \l{Animation and Transitions in Qt Quick}{transitions}
|
||||||
when using Qt 6 as the minimum Qt version and CMake as the build system.
|
when using Qt 6 as the minimum Qt version and CMake as the build system.
|
||||||
|
|
||||||
You will use the \l{Working in Edit Mode}{Edit mode} to create an application
|
You will use the \l{Edit Mode}{Edit} mode to create an application
|
||||||
that moves a Qt logo between three rectangles when you click them.
|
that moves a Qt logo between three rectangles when you click them.
|
||||||
|
|
||||||
\image qtquick-tutorial.gif {Transitions example}
|
\image qtquick-tutorial.gif {Transitions example}
|
||||||
|
@@ -37,7 +37,7 @@
|
|||||||
\li \uicontrol Edit
|
\li \uicontrol Edit
|
||||||
\li \key Ctrl+2
|
\li \key Ctrl+2
|
||||||
\li Edit project and source files.
|
\li Edit project and source files.
|
||||||
\li \l{Working in Edit Mode}
|
\li \l{Edit Mode}
|
||||||
\row
|
\row
|
||||||
\li \uicontrol Design
|
\li \uicontrol Design
|
||||||
\li \key Ctrl+3
|
\li \key Ctrl+3
|
||||||
|
@@ -65,7 +65,7 @@
|
|||||||
incoming calls.
|
incoming calls.
|
||||||
|
|
||||||
Select the \inlineimage icons/languageclient.png
|
Select the \inlineimage icons/languageclient.png
|
||||||
button on the \l{Managing Language Servers}{editor toolbar}, and then select
|
button on the \l{Edit Mode}{editor toolbar}, and then select
|
||||||
\uicontrol {Restart} to collect call hierarchy information for the function.
|
\uicontrol {Restart} to collect call hierarchy information for the function.
|
||||||
|
|
||||||
\image qtcreator-call-hierarchy-view.png {Call Hierarchy view}
|
\image qtcreator-call-hierarchy-view.png {Call Hierarchy view}
|
||||||
|