diff --git a/doc/images/qtcreator-show-subprojects.png b/doc/images/qtcreator-show-subprojects.png new file mode 100644 index 0000000000000000000000000000000000000000..695a2f9c8950e7fe10fe9c4194b8bd1710584e45 Binary files /dev/null and b/doc/images/qtcreator-show-subprojects.png differ diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index d0ba687ac799b03f606edf462d02cb4e1b513986..b6946b4b90b4308371e8ce7fd9d47ec7ad18e6cd 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -588,17 +588,24 @@ \section1 Browsing Project Contents The sidebar is available in the \gui Edit and \gui Debug modes. - Use the sidebar to browse files, projects and bookmarks. + Use the sidebar to browse projects, files, and bookmarks, and to view + the class hierarchy. \image qtcreator-sidebar.png You can select the content of the sidebar in the sidebar menu: \list \o \gui Projects shows a list of projects open in the current session. - \o \gui{File System} shows the content of the currently selected - directory. - \o \gui Bookmarks shows all bookmarks for the current session. \o \gui{Open Documents} shows currently open files. + \o \gui Bookmarks shows all bookmarks for the current session. + \o \gui{File System} shows all files in the currently selected + directory. + \o \gui {Class View} shows the class hierarchy of the currently + open projects. + \o \gui Outline shows the element hierarchy of a QML file. + \o \gui {Type Hierarchy} shows the base classes of a class. For + more information, see \l{Viewing Type Hierarchy}. + \endlist You can change the view of the sidebar in the following ways: @@ -612,6 +619,8 @@ . \endlist + The additional options in each view are described in the following + sections. \section2 Viewing Project Files @@ -625,20 +634,53 @@ needed right-click an item in the project tree. For example, through the menu of the project root directory you can, among other actions, build, re-build, clean and run the project. - \o To list all files in a project, click + \o To hide the categories and sort project files alphabetically, click \inlineimage qtcreator-filter.png - and select \gui{Simplify tree}. + and select \gui{Simplify Tree}. \o To hide source files which are automatically generated by the build system, during a build, click \inlineimage qtcreator-filter.png - and select \gui{Hide generated files}. - \o To toggle the synchronization of your project tree with the file - opened in the editor, click + and select \gui{Hide Generated Files}. + \o To keep the position in the project tree synchronized with the file + currently opened in the editor, click \inlineimage qtcreator-synchronizefocus.png . \o To see the absolute path of a file, move the mouse pointer over the file name. \endlist + \section2 Viewing the File System + + If you cannot see a file in the \gui Projects view, switch to the + \gui {File System} view, which shows all the files in the file system. + + To keep the position in the tree synchronized with the file + opened in the editor, click + \inlineimage qtcreator-synchronizefocus.png + . + + \section2 Viewing the Class Hierarchy + + The \gui {Class View} shows the class hierarchy of the currently + open projects. To organize the view by subprojects, click + \inlineimage qtcreator-show-subprojects.png + . + + \section2 Viewing QML Elements + + The \gui Outline view shows the element hierarchy in a QML file. + + \list + + \o To see a complete list of all bindings, click + \inlineimage qtcreator-filter.png + and select \gui{Show All Bindings}. + + \o To keep the position in the view synchronized with the element + selected in the editor, click + \inlineimage qtcreator-synchronizefocus.png + . + + \endlist \section1 Viewing Output