Commit 33bdffed authored by Kavindra Palaraja's avatar Kavindra Palaraja
Browse files

Fixes: More documentation cleanups, updated 1 screenshot, added 2 new ones

parent 5e0e40cf
doc/qtcreator-navigate-customfilter.png

52.3 KB | W: | H:

doc/qtcreator-navigate-customfilter.png

32.6 KB | W: | H:

doc/qtcreator-navigate-customfilter.png
doc/qtcreator-navigate-customfilter.png
doc/qtcreator-navigate-customfilter.png
doc/qtcreator-navigate-customfilter.png
  • 2-up
  • Swipe
  • Onion skin
...@@ -541,47 +541,58 @@ ...@@ -541,47 +541,58 @@
criteria will be displayed. criteria will be displayed.
\gui Locator not only allows you to navigate files on disk but also other \gui Locator not only allows you to navigate files on disk but also other
"locations", which are organized with \bold{Filters}. "locations", which are organized with \bold{Filters}. Currently there are
filters for:
As mentioned above, files are not the only type of locations you can
jump to. The different types of locations are organized in what we
call \c{filters}. There are filters for jumping to
\list \list
\o files mentioned in your \c{.pro} files, such as source and header, \o files anywhere on your hard disk (browsing through the file system),
resource and \c{.ui} files, \o files from a subdirectory structure defined by you,
\o a specific line in your current text document, \o files mentioned in your \c{.pro} files, such as source, header,
\o class and method definitions in your project or anywhere referenced resource, and \c{.ui} files,
from your project, \o any open document,
\o help topics, including the Qt API reference documentation, \o class and method definitions in your project or anywhere referenced
\o files anywhere on your hard disk (by browsing through the file system), from your project,
\o any open document, \o help topics, including Qt's documentation, and,
\o files from a subdirectory structure you define. \o a specific line in the document displayed on your editor,
\endlist \endlist
Some of these filters are not used by default if you just start typing in the
input field, but require you to type a "prefix" in front, that is
assigned to that filter. The prefix is usually a single character, Some of these filters require you to activate them by typing an assigned
followed by a space. As an example, to jump to the definition of the class \e prefix. This prefix is usually a single character followed by
\c{QDataStream} type \key{Ctrl+K}, \key{:}, \key{Space}, and the class name. \key{Space}. For example, to jump to the definition of the class
You find a full list of filters and their prefixes below. \l{http://doc.trolltech.com/qdatastream.html}{QDataStream}, type:
\key{Ctrl+K} to activate \gui Locator. Then type colon (\key{:}) followed
by \key{Space} and the class name.
Below is a full list of \l{http://doc.trolltech.com/qdatastream.html}
{QDataStream} related output:
\image qtcreator-navigate-popup.png \image qtcreator-navigate-popup.png
You can add filters that provide quick navigation to files in a
subdirectory structure that you define. This way you have quick access to Filters can be added to provide quick navigation around files in a
files that are not directly mentioned in your project, but still relate to it. subdirectory structure defined by you. This way, you can acccess files you
Click on the little magnifier glass in the input field and choose need, that are not directly mentioned in your project. Click on
\gui{Configure...} from the menu that appears. This opens the preferences \image qtcreator-locator-magnify.png
dialog for navigation filters. Click the \gui{Add} button to create a new and choose \gui{Configure...} from the menu displayed.
filter. Give it a name, choose directories, set (a comma separated list of)
file patterns, and give it a prefix string. After closing the preferences \image qtcreator-locator-customize.png
dialog the directories you specified are searched for files that match the
file patterns, and the information is cached. From now on you can jump to This then displays the \gui Preferences dialog (\gui Options on Mac Os X)
these files by just typing part of the file name into the navigation input for navigation filters. Click \gui Add to create a new filter. In the
field. You can force an update of the cached information about the files via \gui{Filter Configuration} dialog below, give your filter a name, select
the \gui{Refresh} menu item in the magnifier menu. your preferred directories, set file patterns with a comma separated list,
and specify a prefix string.
\image qtcreator-navigate-customfilter.png \image qtcreator-navigate-customfilter.png
After closing this dialog, \gui Locator will search the directories you
selected for files matching your file patterns, and the information will be
cached. Click \gui Refresh from the menu above to update the cached
information.
The following table lists the filters currently available: The following table lists the filters currently available:
\table \table
...@@ -601,7 +612,7 @@ ...@@ -601,7 +612,7 @@
\o Go to an Already Opened Document \o Go to an Already Opened Document
\o Ctrl + K, o, Space, and the document name. \o Ctrl + K, o, Space, and the document name.
\row \row
\o Go to a File in the File System (browsing the file system) \o Go to a File in the File System (browse the file system)
\o Ctrl + K, f, Space, and the file name. \o Ctrl + K, f, Space, and the file name.
\row \row
\o Go to a File in any Loaded Project \o Go to a File in any Loaded Project
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment