Doc: Update locator information
- Use QML code in examples and enable the hiding of C++-specific information by using defines. - Update screenshots - Update info about "Filter Configuration" dialog Change-Id: Ia2ca4220a46308c6f480965153ac1002f9790054 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 5.0 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 49 KiB |
Before Width: | Height: | Size: 7.4 KiB After Width: | Height: | Size: 18 KiB |
@@ -50,19 +50,20 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To edit the currently open project's main.cpp file using the locator:
|
To open a QML file called \e HelloWorld.qml in the currently open project
|
||||||
|
using the locator:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
|
|
||||||
\li Activate the locator by pressing \key {Ctrl+K}.
|
\li Activate the locator by pressing \key {Ctrl+K}.
|
||||||
|
|
||||||
\li Enter \c {main.cpp}.
|
\li Start typing the filename.
|
||||||
|
|
||||||
\image qtcreator-locator-open.png
|
\image qtcreator-locator-open.png
|
||||||
|
|
||||||
\li Press \key Enter.
|
\li Move to the filename in the list and press \key Enter.
|
||||||
|
|
||||||
The \c {main.cpp} file opens in the editor.
|
The file opens in the editor.
|
||||||
|
|
||||||
\li To move to a line in the file, enter the line number in the locator.
|
\li To move to a line in the file, enter the line number in the locator.
|
||||||
|
|
||||||
@@ -70,8 +71,8 @@
|
|||||||
|
|
||||||
To move directly to a particular line and column in the document when you
|
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
|
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
|
plus signs (+) or colons (:). For example, to open \e HelloWorld.qml to line
|
||||||
column 2, enter: \c {main.cpp:41:2}.
|
41 and column 2, enter: \c {HelloWorld.qml:41:2}.
|
||||||
|
|
||||||
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
|
||||||
@@ -107,13 +108,17 @@
|
|||||||
\li Locating files anywhere on your file system (\c {f})
|
\li Locating files anywhere on your file system (\c {f})
|
||||||
|
|
||||||
\li Locating files belonging to your project (\c {p}), such as source,
|
\li Locating files belonging to your project (\c {p}), such as source,
|
||||||
header resource, and \c {.ui} files, or to any project (\c {a})
|
header, resource, and \c {.ui} files, or to any project (\c {a})
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
\li Locating bookmarks (\c {b}).
|
\li Locating bookmarks (\c {b}).
|
||||||
For more information, see \l{Using Bookmarks}.
|
For more information, see \l{Using Bookmarks}.
|
||||||
|
|
||||||
\li Locating class (\c {c}), enum, and function (m) definitions in your
|
\li Locating class (\c {c}), enum, and function (m) definitions in your
|
||||||
project or anywhere referenced from your project (\c {:})
|
project or anywhere referenced from your project (\c {:})
|
||||||
|
\endif
|
||||||
|
|
||||||
|
\li Locating QML methods (m)
|
||||||
|
|
||||||
\li Locating symbols in the current document (\c {.})
|
\li Locating symbols in the current document (\c {.})
|
||||||
|
|
||||||
@@ -124,20 +129,28 @@
|
|||||||
|
|
||||||
\li Performing web searches (\c {r})
|
\li Performing web searches (\c {r})
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
\li Running text editing macros that you record and save (\c {rm}). For
|
\li Running text editing macros that you record and save (\c {rm}). For
|
||||||
more information, see \l{Using Text Editing Macros}
|
more information, see \l{Using Text Editing Macros}
|
||||||
|
\endif
|
||||||
|
|
||||||
\li Executing JavaScript (\c {=}), especially useful for calculations.
|
\li Executing JavaScript (\c {=}), especially useful for calculations.
|
||||||
For more information, see \l{Executing JavaScript}.
|
For more information, see \l{Executing JavaScript}.
|
||||||
|
|
||||||
\li Executing shell commands (\c {!})
|
\li Executing shell commands (\c {!})
|
||||||
|
|
||||||
\li Executing version control system commands (\c {git}). For more
|
\li Executing version control system commands (\c {git}).
|
||||||
information, see \l{Using Version Control Systems}
|
\if defined(qtcreator)
|
||||||
|
For more information, see \l{Using Version Control Systems}
|
||||||
|
\else
|
||||||
|
For more information, see \l{Using Git}
|
||||||
|
\endif
|
||||||
|
|
||||||
\li Triggering menu items from the main menu (\c {t})
|
\li Triggering menu items from the main menu (\c {t})
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
\li Running external tools (\c x)
|
\li Running external tools (\c x)
|
||||||
|
\endif
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
@@ -150,6 +163,7 @@
|
|||||||
keyboard shortcuts to move up and down the list, and then press \key Enter
|
keyboard shortcuts to move up and down the list, and then press \key Enter
|
||||||
to use the selected filter.
|
to use the selected filter.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
For example, to locate symbols matching QDataStream:
|
For example, to locate symbols matching QDataStream:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
@@ -172,6 +186,7 @@
|
|||||||
Filters locating files also accept paths, such as \c {tools/*main.cpp}.
|
Filters locating files also accept paths, such as \c {tools/*main.cpp}.
|
||||||
Filters locating class and function definitions also accept namespaces,
|
Filters locating class and function definitions also accept namespaces,
|
||||||
such as \c {Utils::*View}.
|
such as \c {Utils::*View}.
|
||||||
|
\endif
|
||||||
|
|
||||||
For example, to create a new file and open it in the editor, type \c f
|
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
|
followed by \key Space, followed by path and file name, and then press
|
||||||
@@ -273,24 +288,29 @@
|
|||||||
|
|
||||||
\li In the \uicontrol {Filter Configuration} dialog:
|
\li In the \uicontrol {Filter Configuration} dialog:
|
||||||
|
|
||||||
|
\image qtcreator-navigate-customfilter.png
|
||||||
|
|
||||||
\list
|
\list
|
||||||
|
|
||||||
\li Name your filter.
|
\li In the \uicontrol Name field, enter a name for your filter.
|
||||||
|
|
||||||
\li Select at least one directory. The locator searches directories
|
\li In the \uicontrol Directories field, select at least one
|
||||||
recursively.
|
directory. The locator searches directories recursively.
|
||||||
|
|
||||||
\li Define the file pattern as a comma separated list. For example,
|
\li In the \uicontrol {File pattern} field, specify file patterns to
|
||||||
to search all \c {.h} and \c {.cpp} files, enter \c{*.h,*.cpp}
|
restrict the search to files that match the pattern.
|
||||||
|
Use a comma separated list. For example, to search for all
|
||||||
|
\c {.qml} and \c {.ui.qml} files, enter \c{*.qml,*.ui.qml}
|
||||||
|
|
||||||
\li Specify the prefix string.
|
\li In the \uicontrol {Exclusion pattern} field, specify file
|
||||||
|
patterns to omit files from the search.
|
||||||
|
|
||||||
|
\li In the \uicontrol Prefix field, specify the prefix string.
|
||||||
|
|
||||||
To implicitly include the filter even when not typing a prefix
|
To implicitly include the filter even when not typing a prefix
|
||||||
as a part of the search string, select
|
as a part of the search string, select
|
||||||
\uicontrol {Include by default}.
|
\uicontrol {Include by default}.
|
||||||
|
|
||||||
\image qtcreator-navigate-customfilter.png
|
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
\li Click \uicontrol OK.
|
\li Click \uicontrol OK.
|
||||||
|