summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-08-28 11:38:41 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-08-28 10:26:25 +0000
commite1e17904021cd05f7e9733fefbba519a557eb268 (patch)
tree339140535914eec565d7d5e67e6f2d7bc82d4ee6 /doc
parentefe7c56e625f82afb6e5e2247c20d1bb796897e4 (diff)
downloadqt-creator-e1e17904021cd05f7e9733fefbba519a557eb268.tar.gz
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/qtcreator-add-online-doc.pngbin11457 -> 36820 bytes
-rw-r--r--doc/images/qtcreator-locator-customize.pngbin17110 -> 54490 bytes
-rw-r--r--doc/images/qtcreator-locator-open.pngbin5163 -> 30144 bytes
-rw-r--r--doc/images/qtcreator-locator.pngbin13059 -> 49928 bytes
-rw-r--r--doc/images/qtcreator-navigate-customfilter.pngbin7539 -> 18754 bytes
-rw-r--r--doc/src/editors/creator-locator.qdoc54
6 files changed, 37 insertions, 17 deletions
diff --git a/doc/images/qtcreator-add-online-doc.png b/doc/images/qtcreator-add-online-doc.png
index c607de32d8..4081f15fb8 100644
--- a/doc/images/qtcreator-add-online-doc.png
+++ b/doc/images/qtcreator-add-online-doc.png
Binary files differ
diff --git a/doc/images/qtcreator-locator-customize.png b/doc/images/qtcreator-locator-customize.png
index c9899959df..6b7aacf7d3 100644
--- a/doc/images/qtcreator-locator-customize.png
+++ b/doc/images/qtcreator-locator-customize.png
Binary files differ
diff --git a/doc/images/qtcreator-locator-open.png b/doc/images/qtcreator-locator-open.png
index 017bc31afa..62dea9497e 100644
--- a/doc/images/qtcreator-locator-open.png
+++ b/doc/images/qtcreator-locator-open.png
Binary files differ
diff --git a/doc/images/qtcreator-locator.png b/doc/images/qtcreator-locator.png
index ae3b1f2b2e..0b4097394a 100644
--- a/doc/images/qtcreator-locator.png
+++ b/doc/images/qtcreator-locator.png
Binary files differ
diff --git a/doc/images/qtcreator-navigate-customfilter.png b/doc/images/qtcreator-navigate-customfilter.png
index 31f0725492..2ce1d850d8 100644
--- a/doc/images/qtcreator-navigate-customfilter.png
+++ b/doc/images/qtcreator-navigate-customfilter.png
Binary files differ
diff --git a/doc/src/editors/creator-locator.qdoc b/doc/src/editors/creator-locator.qdoc
index e46628ba42..7d8f25dd07 100644
--- a/doc/src/editors/creator-locator.qdoc
+++ b/doc/src/editors/creator-locator.qdoc
@@ -50,19 +50,20 @@
\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
\li Activate the locator by pressing \key {Ctrl+K}.
- \li Enter \c {main.cpp}.
+ \li Start typing the filename.
\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.
@@ -70,8 +71,8 @@
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}.
+ plus signs (+) or colons (:). For example, to open \e HelloWorld.qml to line
+ 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
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 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}).
For more information, see \l{Using Bookmarks}.
\li Locating class (\c {c}), enum, and function (m) definitions in your
project or anywhere referenced from your project (\c {:})
+ \endif
+
+ \li Locating QML methods (m)
\li Locating symbols in the current document (\c {.})
@@ -124,20 +129,28 @@
\li Performing web searches (\c {r})
+ \if defined(qtcreator)
\li Running text editing macros that you record and save (\c {rm}). For
more information, see \l{Using Text Editing Macros}
+ \endif
\li Executing JavaScript (\c {=}), especially useful for calculations.
For more information, see \l{Executing JavaScript}.
\li Executing shell commands (\c {!})
- \li Executing version control system commands (\c {git}). For more
- information, see \l{Using Version Control Systems}
+ \li Executing version control system commands (\c {git}).
+ \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})
+ \if defined(qtcreator)
\li Running external tools (\c x)
+ \endif
\endlist
@@ -150,6 +163,7 @@
keyboard shortcuts to move up and down the list, and then press \key Enter
to use the selected filter.
+ \if defined(qtcreator)
For example, to locate symbols matching QDataStream:
\list 1
@@ -172,6 +186,7 @@
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
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
@@ -273,24 +288,29 @@
\li In the \uicontrol {Filter Configuration} dialog:
+ \image qtcreator-navigate-customfilter.png
+
\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
- recursively.
+ \li In the \uicontrol Directories field, 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 In the \uicontrol {File pattern} field, specify file patterns to
+ 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
as a part of the search string, select
\uicontrol {Include by default}.
- \image qtcreator-navigate-customfilter.png
-
\endlist
\li Click \uicontrol OK.