aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/projects/creator-projects-custom-wizards.qdoc
blob: fc57ff4c7ffcb88f92db51e97fb8f8f1335cf6c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/****************************************************************************
**
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
    \contentspage {Qt Creator Manual}
    \previouspage creator-project-qmake-libraries.html
    \page creator-project-wizards.html
    \nextpage creator-project-wizards-json.html

    \title 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 \uicontrol New
    dialog that opens when you choose \uicontrol {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.

    \section1 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:

    \list
        \li \l{Adding JSON-Based Wizards}
        \li \l{Adding XML-Based Wizards}
    \endlist

    The following table summarizes the wizards you can create:

    \table
        \header
            \li Wizard Type
            \li JSON-Based
            \li XML-Based
        \row
            \li Class
            \li \image ok
            \li \image ok
        \row
            \li File
            \li \image ok
            \li \image ok
        \row
            \li Project
            \li \image ok
            \li \image ok
    \endtable

    \section1 Locating Wizards

    Wizards are located in subdirectories of the following directories:

    \list

        \li \c{share/qtcreator/templates/wizards}

        \li the local user's configuration folder,
            \c{$HOME/.config/QtProject/qtcreator/templates/wizards}

        \li \c{%APPDATA%\QtProject\qtcreator\templates\wizards}

    \endlist

*/