- Qt Creator Manual
- How To
- Qt Creator Manual 13.0.0-rc1

Using Squish ◦ Reference

# How To

The following topics describe how to use Qt Creator to perform a particular task.

## Analyze

Qt Creator integrates code analysis tools for detecting memory leaks, profiling function execution, analyzing CPU use, and eliminating unnecessary complexity of code. Other integrated tools provide code coverage and visualize trace events.

- Analyze code with Clang-Tidy and Clazy
- Configure Clang diagnostics
- Create compiler explorer sessions
- Explore compiler code
- Prevent code erosion
- Profile CMake code
- Specify Valgrind settings for a project

## Build and Run

- Activate custom output parsers
- Add custom output parsers
- Configure projects for building
- Customize the build process
- Edit Qbs profiles
- Edit vcpkg manifest files
- Enable debugging
- Use compilation databases

### Build with CMake

- Add CMake tools
- Add libraries to CMake projects
- Complete CMake code
- Debug CMake project files
- Edit CMake configuration files
- Format CMake files
- Manage files in CMake projects
- Profile CMake code
- Read CMake documentation
- View CMake project contents

### Build with qmake

- Add libraries to qmake projects

### Run applications

- Configure projects for running
- Run Python applications
- Run in Qt Application Manager
- Run on QNX devices
- Run on many platforms
- Run on remote Linux devices
- Specify a custom executable to run

## Create Models and Diagrams

- Create UML-style models
- Create class diagrams
- Create component diagrams
- Create package diagrams
- Create state charts

## Debug

- Debug CMake project files

## Design UIs

- Export SVG images
- Run QML files
- View images

## Edit Code

- Apply quick fixes
- Bookmark code
- Compare files
- Complete code
- Document code
- Edit Markdown files
- Enclose code in brackets or quotes
- Indent text or code
- Insert multiple cursors
- Inspect the code model
- Locate files using the keyboard
- Move between files
- Move in QML code
- Move to symbols
- Parse files
- Paste text from clipboard history
- Perform calculations
- Record text editing macros
- Select the enclosing block in C++
- Split the editor view
- Switch to Edit mode
- Write down notes

### Configure Editors

- Add code snippets to the auto-complete menu
- Beautify source code
- Change editor colors
- Change text encoding
- Edit MIME types
- Edit like in Vim
- Select line ending style
- Specify code style

### Manage Language Servers

- Add a Java language server
- Add generic language servers
- Configure Python language servers
- Configure language server workspace
- Inspect language clients
- Turn on QML Language Server

### Search

- Find symbols
- Navigate with locator
- Rename symbols
- Search and replace using a regular expression
- Search in current file
- Search in projects or file systems
- Turn on Silver Searcher

## Manage Kits

- Add Nim compilers
- Add Qt versions
- Add compilers
- Add custom compilers
- Add debuggers
- Add kits

## Manage Projects

- Add libraries to CMake projects
- Configure projects for building
- Configure projects for running
- Create vcpkg manifest files
- Develop Qt for Python applications
- Edit environment settings
- Enable debugging
- Import an existing project
- Run Python applications
- Specify the environment for projects
- Use Qt Creator variables

### Create Projects

- Add libraries to qmake projects
- Add subprojects to projects
- Add wizards
- Create Nimble projects
- Create Qt Quick Applications
- Create Qt Quick UI Prototypes
- Create VCS repositories for new projects
- Select the build system
- Use project wizards

### Add Files

- Add a license header template for C++ code
- Add translation files
- Create C++ classes
- Create OpenGL fragment and vertex shaders
- Create files
- Create resource files
- Set C++ file naming preferences

### Configure Projects

- Activate kits for a project
- Configure language server workspace
- Exclude files from to-do lists
- Link projects to Axivion dashboards
- Open projects
- Share project settings
- Specify clangd settings
- Specify dependencies
- Specify editor settings
- Specify project contents
- Specify settings for quick fixes
- Speficy Clang tools settings

## Read Documentation

- Add bookmarks to help pages
- Add external documentation
- Detach the help window
- Filter documentation
- Find information in Qt documentation
- Get help
- Read CMake documentation
- Search from documentation
- Select the help start page

## Test

Qt Creator supports both code based tests and build system based tests. Code based testing offers special handling for particular testing frameworks that strongly ties to the underlying code models or specialized parsers. Build system based testing is independent from any testing frameworks. It retrieves information directly from the underlying build system and uses it or even the build system as such to execute the respective tests.

- Add tests to existing test projects
- Build and run tests
- Create Boost tests
- Create CTest Based Tests
- Create Catch2 tests
- Create Google tests
- Create Qt Quick tests
- Create Qt tests

## Use Qt Creator

- Collect usage statistics
- Contact Qt
- Enable and disable plugins
- Find settings files
- Inspect internal logs
- Install Qt Creator
- Install plugins
- Manage data collection
- Manage sessions
- Record screens
- Run Qt Creator from the command line
- Set up version control systems
- Use Qt Linguist
- Use common VCS functions
- Use external text editors
- Use external tools

## Use the UI

- Assign keyboard shortcuts
- Detach views
- Find keyboard shortcuts
- Find preferences
- Set high DPI scaling
- Set the number of recent files shown
- Show and hide sidebars
- Show and hide the main menu
- Show task list files in issues
- Switch UI themes
- Switch between modes
- View output

Using Squish ◦ Reference