Qt Creator Documentation

Qt Creator User Interface

When you start Qt Creator, it opens to the Welcome mode, where you can:

  • Open tutorials and example projects
  • View tips and hints on using Qt Creator
  • Create and open projects
  • Send feedback to the development team
  • Open recent sessions and projects
  • Read news from the Qt labs
  • Ask for support

You can use the mode selector to change to another Qt Creator mode. The following image displays an example application in Edit mode and Design mode.

"Edit mode and Design mode"

Qt Creator has been localized into several languages. If the system language is one of the supported languages, it is automatically selected. To change the language, select Tools > Options > Environment and select a language in the Language field. The change takes effect after you restart Qt Creator.

Qt Creator Modes

The mode selector allows you to quickly switch between tasks such as editing project and source files, designing application UIs, configuring how projects are built and executed, and debugging your applications. To change modes, click the icons, or use the corresponding keyboard shortcut.

You can use Qt Creator in the following modes:

  • Edit mode for editing project and source files.
  • Design mode for designing and developing application user interfaces. This mode is available for UI files (.ui or .qml).
  • Debug mode for inspecting the state of your program while debugging.
  • Projects mode for configuring project building and execution. This mode is available when a project is open.
  • Help mode for viewing Qt documentation.

Certain actions in Qt Creator trigger a mode change. Clicking on Debug > Start Debugging > Start Debugging automatically switches to Debug mode.

Browsing Project Contents

The sidebar is available in the Edit and Debug modes. Use the sidebar to browse projects, files, and bookmarks, and to view the class hierarchy.

You can select the content of the sidebar in the sidebar menu:

  • Projects shows a list of projects open in the current session.
  • Open Documents shows currently open files.
  • Bookmarks shows all bookmarks for the current session.
  • File System shows all files in the currently selected directory.
  • Class View shows the class hierarchy of the currently open projects.
  • Outline shows the element hierarchy of a QML file.
  • Type Hierarchy shows the base classes of a class. For more information, see Viewing Type Hierarchy.

You can change the view of the sidebar in the following ways:

  • To toggle the sidebar, click or press Alt+0 (Cmd+0 on Mac OS X).
  • To split the sidebar, click . Select new content to view in the split view.
  • To close a sidebar view, click .

The additional options in each view are described in the following sections.

Viewing Project Files

The sidebar displays projects in a project tree. The project tree contains a list of all projects open in the current session. The files for each project are grouped according to their file type.

You can use the project tree in the following ways:

  • To bring up a context menu containing the actions most commonly 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.
  • To hide the categories and sort project files alphabetically, click and select Simplify Tree.
  • To hide source files which are automatically generated by the build system, during a build, click and select Hide Generated Files.
  • To keep the position in the project tree synchronized with the file currently opened in the editor, click .
  • To see the absolute path of a file, move the mouse pointer over the file name.

Viewing the File System

If you cannot see a file in the Projects view, switch to the 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 .

Viewing the Class Hierarchy

The Class View shows the class hierarchy of the currently open projects. To organize the view by subprojects, click .

Viewing QML Elements

The Outline view shows the element hierarchy in a QML file.

  • To see a complete list of all bindings, click and select Show All Bindings.
  • To keep the position in the view synchronized with the element selected in the editor, click .

Viewing Output

The task pane in Qt Creator can display one of the following panes:

  • Build Issues
  • Search Results
  • Application Output
  • Compile Output
  • General Messages
  • Version Control

Output panes are available in all modes. Click the name of an output pane to open the pane. To maximize an open output pane, click the Maximize Output Pane button or press Alt+9.

To search within the Application Output and Compile Output panes, press Ctrl+F when the pane is active. Enter search criteria in the Find field and click the left and right arrows to search down and up in the pane.

To open the General Messages and Version Control panes, select Window > Output Panes.

Build Issues

The Build Issues pane provides a list of errors and warnings encountered during a build. The pane filters out irrelevant output from the build tools and presents the issues in an organized way.

Right-clicking on a line brings up a context menu with options to copy the contents and to show a version control annotation view of the line that causes the error message.

To view task lists in the Build Issues pane, click and select My Tasks. Entries from a task list file (.tasks) are imported to the pane. Press F6 and Shift+F6 to jump from one issue to the next.

For more information about creating task files, see Creating Task List Files.

Search Results

The Search Results pane displays the results for global searches, for example, searching within a current document, files on disk, or all projects.

The figure below shows an example search result for all occurrences of textfinder within the "/TextFinder" directory.

Application Output

The Application Output pane displays the status of a program when it is executed, and the debug output.

The figure below shows an example output from qDebug().

Compile Output

The Compile Output pane provides all output from the compiler. The Compile Output is a more detailed version of information displayed in the Build Issues pane.

Navigating with Keyboard

Qt Creator caters not only to developers who are used to using the mouse, but also to developers who are more comfortable with the keyboard. A wide range of keyboard and navigation shortcuts are available to help speed up the process of developing your application.

[Previous: Operating Systems and Supported Platforms] [Next: Getting Started]

X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.

s.parentNode.insertBefore(ga, s); })(); -->