Adding New Custom Wizards

If you have a team working on a large application or several applications, you might want to standardize the way the team members create projects, classes, and files.

You can copy the wizard templates in the template folders to create your own project, class, and file wizards. They are displayed in the New dialog that opens when you choose File > New File or Project.

A custom wizard defines the user interface of a wizard page. The values the user enters in the wizard are assigned field names. Field name and value pairs are then passed to the file creation process.

Wizard Types

In a project wizard, you can specify the files needed in a project. You can add wizard pages to allow developers to specify settings for the project.

In a class wizard, you can allow developers to specify the class name, base class, and header and source files for the class.

In a file wizard, you can allow developers to specify the type and location of the file.

You can create either JSON-based or XML-based wizards. We recommend creating JSON-based wizards for new projects. For more information, see:

The following table summarizes the wizards you can create:

Wizard TypeJSON-BasedXML-Based
Class

File

Project

Locating Wizards

Wizards are located in subdirectories of the following directories:

  • share/qtcreator/templates/wizards
  • the local user's configuration folder, $HOME/.config/QtProject/qtcreator/templates/wizards
  • %APPDATA%\QtProject\qtcreator\templates\wizards

© 2015 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.