diff options
Diffstat (limited to 'doc/src/projects/creator-projects-custom-wizards.qdoc')
| -rw-r--r-- | doc/src/projects/creator-projects-custom-wizards.qdoc | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/doc/src/projects/creator-projects-custom-wizards.qdoc b/doc/src/projects/creator-projects-custom-wizards.qdoc index c4f5c2bad0..b3e27cc8d4 100644 --- a/doc/src/projects/creator-projects-custom-wizards.qdoc +++ b/doc/src/projects/creator-projects-custom-wizards.qdoc @@ -64,13 +64,13 @@ \list 1 - \o Template-based, where source files that contain placeholders for + \li Template-based, where source files that contain placeholders for the field names are provided. During processing, the placeholders are replaced by the values from the wizard page. Optionally, modifier characters are applied. For more information, see \l{Processing Template Files}. - \o Generator script, where a script is called to create the files. + \li Generator script, where a script is called to create the files. \note This option mainly exists to accommodate existing generator scripts or cases where complicated algorithmic logic is required @@ -84,12 +84,12 @@ \list - \o \c{share/qtcreator/templates/wizards} + \li \c{share/qtcreator/templates/wizards} - \o the local user's configuration folder, + \li the local user's configuration folder, \c{$HOME/.config/QtProject/qtcreator/templates/wizards} - \o \c{%APPDATA%\QtProject\qtcreator\templates\wizards} + \li \c{%APPDATA%\QtProject\qtcreator\templates\wizards} \endlist @@ -102,12 +102,12 @@ \list 1 - \o Make a copy of the \c {share/qtcreator/templates/wizards/helloworld} + \li Make a copy of the \c {share/qtcreator/templates/wizards/helloworld} or \c {share/qtcreator/templates/wizards/listmodel} folder. - \o Modify the wizard_example.xml file. + \li Modify the wizard_example.xml file. - \o The following code determines the type of the wizard and its place + \li The following code determines the type of the wizard and its place in the \gui New dialog: \code @@ -120,32 +120,32 @@ \list - \o \c version is the version of the file contents. Do not modify + \li \c version is the version of the file contents. Do not modify this value. - \o \c kind specifies the type of the wizard: \c project or + \li \c kind specifies the type of the wizard: \c project or \c class. - \o \c class specifies the type of the project. This attribute is + \li \c class specifies the type of the project. This attribute is optional. Use the value \c qt4project to add Qt 4 specific pages. - \o \c firstpage specifies the place of the new page in the standard + \li \c firstpage specifies the place of the new page in the standard project wizard. The value 10 ensures that the custom page appears after the standard pages, as the last page of the wizard. - \o \c id is the unique identifier for your wizard. The letter + \li \c id is the unique identifier for your wizard. The letter specifies the position of the wizard within the \c category. The HelloWorld wizard appears as the first wizard in the second category in the \gui New dialog. - \o \c category is the category in which to place the wizard in the + \li \c category is the category in which to place the wizard in the list. The letter specifies the position of the category in the list in the \gui New dialog. \endlist - \o The following code specifies the icon and text that appear in the + \li The following code specifies the icon and text that appear in the \gui New dialog: \code @@ -162,13 +162,13 @@ \list - \o \c displayCategory appears in the \gui New dialog, under + \li \c displayCategory appears in the \gui New dialog, under \gui Projects. - \o \c icon appears next to the \c displayName in the middle panel + \li \c icon appears next to the \c displayName in the middle panel when \c displayCategory is selected. - \o \c description appears in the right-most panel when + \li \c description appears in the right-most panel when \c displayCategory is selected. You can add translations as values for the text elements. Specify the target @@ -177,11 +177,11 @@ \endlist - \o Files to be added to the project: + \li Files to be added to the project: \list - \o Template-based: The following code specifies the files to add to + \li Template-based: The following code specifies the files to add to the project: \code <files> @@ -192,29 +192,29 @@ \list - \o \c source specifies the file to copy to the project. The + \li \c source specifies the file to copy to the project. The files must be located in the wizard folder. - \o \c openeditor indicates that the file is to be opened in an + \li \c openeditor indicates that the file is to be opened in an editor after the wizard has finished. - \o \c binary indicates that the file is a binary file (for + \li \c binary indicates that the file is a binary file (for example, an image file). It is to be copied to the target folder as is. Placeholders are not replaced with values. - \o \c target specifies the new filename for the file. The + \li \c target specifies the new filename for the file. The \c {%ProjectName%} variable is replaced with the string that users specify in the \gui Name field on the first page of the wizard. - \o \c openproject indicates that the file is a project file + \li \c openproject indicates that the file is a project file which is to be opened after the wizard has finished. \endlist See also \l{Processing Template Files}. - \o Generator-script: The following code specifies that the script + \li Generator-script: The following code specifies that the script \c generate.pl is to be used to create the files: \code @@ -233,12 +233,12 @@ \list - \o \c omit-empty specifies that complete argument is to be + \li \c omit-empty specifies that complete argument is to be omitted when all placeholders expand to empty values. In the above example, the option \c --source-suffix will not be passed to the script if the value is empty. - \o \c write-file indicates that instead of the expanded + \li \c write-file indicates that instead of the expanded value, the value will be written to a temporary file and its file name will be passed to the script instead. This is useful for multi-line text fields. @@ -249,7 +249,7 @@ \endlist - \o The following code creates a page that specifies settings for the project: + \li The following code creates a page that specifies settings for the project: \code <!-- Create a 2nd wizard page with parameters --> @@ -266,24 +266,24 @@ \list - \o \c fieldpagetitle specifies the title of the page. + \li \c fieldpagetitle specifies the title of the page. - \o \c field specifies whether the field is mandatory (\c true or + \li \c field specifies whether the field is mandatory (\c true or \c false). You can use the value of the \c name field as a variable in other files (for example, \c {%MESSAGE%}. - \o \c fieldcontrol specifies the field. \c class specifies the + \li \c fieldcontrol specifies the field. \c class specifies the field type. You can use interface objects from the QWidget class to create fields. This example uses QLineEdit to create an input field. - \o \c validator specifies a regular expression to check the + \li \c validator specifies a regular expression to check the characters allowed in the field. - \o \c defaulttext specifies text that appears in the field by + \li \c defaulttext specifies text that appears in the field by default. - \o \c fielddescription specifies the field name that appears on the + \li \c fielddescription specifies the field name that appears on the wizard page. \endlist @@ -299,7 +299,7 @@ \list 1 - \o The following code specifies settings for the wizard: + \li The following code specifies settings for the wizard: \code @@ -319,7 +319,7 @@ For more information about the elements and their values, see \l {Creating Project Wizards}. - \o The following code specifies the files to add to the project: + \li The following code specifies the files to add to the project: \code @@ -335,11 +335,11 @@ \list - \o \c {%ClassName:l%} is replaced with the value of the + \li \c {%ClassName:l%} is replaced with the value of the \c ClassName field. The modifier \c l converts the string to lower case, to observe Qt conventions. - \o \c {%CppSourceSuffix%} and \c {%CppHeaderSuffix%} are + \li \c {%CppSourceSuffix%} and \c {%CppHeaderSuffix%} are pre-defined. For more information, see \l{Pre-defined Standard Variables}. @@ -388,11 +388,11 @@ \list - \o \c{l} for lower case. + \li \c{l} for lower case. - \o \c{u} for upper case. + \li \c{u} for upper case. - \o \c{c} for upper case initial letter ("project" > "Project"). + \li \c{c} for upper case initial letter ("project" > "Project"). \endlist @@ -419,30 +419,30 @@ \list - \o \c {%ProjectName%} is replaced by the name of the project in the + \li \c {%ProjectName%} is replaced by the name of the project in the case of project wizards. - \o \c {%Path%} is replaced by the path to the target directory. For + \li \c {%Path%} is replaced by the path to the target directory. For classes, this is the directory, where the files are created. For project wizards, an additional subdirectory named after the project is created. - \o \c {%TargetPath%} is replaced by the path to the directory where the + \li \c {%TargetPath%} is replaced by the path to the directory where the actual files are created. For non-project wizards, it is identical to \c %Path%. For project wizards, it is \c %Path%/%ProjectName%. - \o \c {%CppSourceSuffix%} is replaced by the default source suffix, + \li \c {%CppSourceSuffix%} is replaced by the default source suffix, which is defined in \QC in \gui {Tools > Options > C++ > - File Naming}. For example, if users enter \bold MyClass, the + File Naming}. For example, if users enter \b MyClass, the filename becomes myclass.cpp when the project is created. - \o \c {%CppHeaderSuffix%} is replaced by the default header suffix, + \li \c {%CppHeaderSuffix%} is replaced by the default header suffix, which is also defined in \gui {File Naming}. - \o \c {%CurrentDate%} is replaced by the current date in the format + \li \c {%CurrentDate%} is replaced by the current date in the format \c {yyyy-MM-dd}. - \o \c {%CurrentTime%} is replaced by the current time in the short + \li \c {%CurrentTime%} is replaced by the current time in the short format of the locale. \endlist @@ -481,7 +481,7 @@ \list 1 - \o Determine file names and attributes: The script is called with the + \li Determine file names and attributes: The script is called with the command line \c{--dry-run} option and the field values. It then prints the relative path names of the files it intends to create, followed by comma-separated attributes matching those of the \c{<file>} element, for @@ -493,7 +493,7 @@ myproject.pro,openproject \endcode - \o Create files: The script is called with the parameters only in the + \li Create files: The script is called with the parameters only in the working directory. It then actually creates the files. If directories are needed, the script should create them, too. |