diff options
author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-12-11 15:43:19 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2014-12-12 10:26:59 +0100 |
commit | e1fbeedcd4e47cb83d00173907607236b06c8ff6 (patch) | |
tree | d34c4961794c6406d05f36aacf215da3ce179a27 /doc/src/projects | |
parent | c9696aa6f4e1a737e3445702b138b2c0a2bd85ce (diff) | |
download | qt-creator-e1fbeedcd4e47cb83d00173907607236b06c8ff6.tar.gz |
Doc: use \uicontrol command instead of \gui macro
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'doc/src/projects')
26 files changed, 267 insertions, 264 deletions
diff --git a/doc/src/projects/creator-projects-autotools.qdoc b/doc/src/projects/creator-projects-autotools.qdoc index 89394975fa..e0a9ff59eb 100644 --- a/doc/src/projects/creator-projects-autotools.qdoc +++ b/doc/src/projects/creator-projects-autotools.qdoc @@ -39,26 +39,27 @@ \title Setting Up an Autotools Project The AutotoolsProjectManager is a plugin for autotools support. It is disabled by default. - To enable the plugin, select \gui{Help > About Plugins > Build Systems > AutotoolsProjectManager}. + To enable the plugin, select \uicontrol{Help > About Plugins > Build Systems + > AutotoolsProjectManager}. To use the plugin, restart \QC. To work with your Autotools project in \QC: \list 1 - \li Select \gui{File > Open File or Project}. + \li Select \uicontrol{File > Open File or Project}. \li Select the Makefile.am file from your project. This is the only way you can use the autotools plugin. \li Select the build directory. Only in-source building is currently supported. - \li Select \gui Finish. + \li Select \uicontrol Finish. \QC displays the project tree structure. The root node displays the project name. All project files are listed below it and you can open them from the list. \image qtcreator-autotools-buildrun.png - \li Select \gui Run to build and run the application. The predefined + \li Select \uicontrol Run to build and run the application. The predefined build steps (autogen.sh or autoreconf, configure, and make) are executed. @@ -66,7 +67,7 @@ executable. \li To check and edit autotools build steps, select - \gui{Projects > Build Settings}. + \uicontrol{Projects > Build Settings}. You can add parameters to the predefined autotools build steps. diff --git a/doc/src/projects/creator-projects-build-run-tutorial.qdoc b/doc/src/projects/creator-projects-build-run-tutorial.qdoc index 0babbea672..2e0c99f14a 100644 --- a/doc/src/projects/creator-projects-build-run-tutorial.qdoc +++ b/doc/src/projects/creator-projects-build-run-tutorial.qdoc @@ -39,23 +39,23 @@ \list 1 - \li In the \gui Welcome mode, select \gui Examples (1). + \li In the \uicontrol Welcome mode, select \uicontrol Examples (1). \image qtcreator-gs-build-example-open.png "Selecting an example" \li Select an example in the list of examples. - You can also search for examples (2). Enter the \gui android or - \gui iOS keyword in the search field to list all the examples tested + You can also search for examples (2). Enter the \uicontrol android or + \uicontrol iOS keyword in the search field to list all the examples tested for Android or iOS. - \note The project opens in the \gui Edit mode, and the documentation + \note The project opens in the \uicontrol Edit mode, and the documentation for the example hides these instructions. To return to these - instructions, select \gui {Previous Page} on the toolbar or + instructions, select \uicontrol {Previous Page} on the toolbar or press \key {Alt+Left}. \li To check that the application code can be compiled and linked for a - device, click the \gui {Kit Selector} and select a + device, click the \uicontrol {Kit Selector} and select a \l{glossary-buildandrun-kit}{kit} for the device. @@ -67,10 +67,10 @@ \li Click \inlineimage qtcreator-run.png - (\gui Run) to build and run the application. + (\uicontrol Run) to build and run the application. \li To see the compilation progress, press \key{Alt+4} to open the - \gui {Compile Output} pane. + \uicontrol {Compile Output} pane. If build errors occur, check that a \l{Adding Qt Versions} {Qt version} and \l{Adding Compilers}{compiler} are installed and @@ -79,7 +79,7 @@ \l{Connecting iOS Devices}{iOS device}, check that the development environment has been set up correctly. - The \gui Build progress bar on the toolbar turns green when the + The \uicontrol Build progress bar on the toolbar turns green when the project is successfully built. The application opens on the device. \endlist diff --git a/doc/src/projects/creator-projects-building-running.qdoc b/doc/src/projects/creator-projects-building-running.qdoc index aded8507b4..07a3f4a0c3 100644 --- a/doc/src/projects/creator-projects-building-running.qdoc +++ b/doc/src/projects/creator-projects-building-running.qdoc @@ -49,7 +49,7 @@ \e {Run configurations} start the application in the location where it was copied by the \e{deploy configuration}. By default, - when you select the \gui Run function, \QC builds the project, + when you select the \uicontrol Run function, \QC builds the project, deploys it to the device defined in the kit, and runs it there. However, if you have not made any changes to the project since you last built and deployed it, \QC simply runs it again. diff --git a/doc/src/projects/creator-projects-building.qdoc b/doc/src/projects/creator-projects-building.qdoc index 59ccb91dd8..d1ee1a9514 100644 --- a/doc/src/projects/creator-projects-building.qdoc +++ b/doc/src/projects/creator-projects-building.qdoc @@ -41,22 +41,22 @@ To check that the application code can be compiled and linked for a device, you can build the project. The build errors and warnings are displayed in - the \gui {Issues} output pane. More detailed information is displayed - in the \gui {Compile Output} pane. + the \uicontrol {Issues} output pane. More detailed information is displayed + in the \uicontrol {Compile Output} pane. To build an application: \list 1 - \li Click the \gui {Build and Run Kit Selector} icon (1) or select - \gui Build > \gui {Open Build and Run Kit Selector} to select the + \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select + \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the build and run \l{glossary-buildandrun-kit}{kit}. \image qtcreator-kit-selector.png "Kit selector" - \li Choose \gui {Build > Build Project} or press \key {Ctrl+B}. + \li Choose \uicontrol {Build > Build Project} or press \key {Ctrl+B}. - You can also select the \gui Run button (2) to also deploy and run + You can also select the \uicontrol Run button (2) to also deploy and run the application after building it. \endlist @@ -65,13 +65,13 @@ \l{Specifying Build Settings}. To quickly check the compile output for changes that you made in one file or - subproject, you can use the \gui Build menu commands to build a file or + subproject, you can use the \uicontrol Build menu commands to build a file or subproject. - To remove all build artifacts, select \gui Build > \gui {Clean All} or - \gui {Clean Project}. To clean the build directory and then build the - project, select \gui Build > \gui {Rebuild All} or \gui {Rebuild Project}. + To remove all build artifacts, select \uicontrol Build > \uicontrol {Clean All} or + \uicontrol {Clean Project}. To clean the build directory and then build the + project, select \uicontrol Build > \uicontrol {Rebuild All} or \uicontrol {Rebuild Project}. - To run qmake to generate new Makefiles, select \gui Build > \gui qmake. + To run qmake to generate new Makefiles, select \uicontrol Build > \uicontrol qmake. */ diff --git a/doc/src/projects/creator-projects-builds-customizing.qdoc b/doc/src/projects/creator-projects-builds-customizing.qdoc index ef05e84a45..2b8149ca58 100644 --- a/doc/src/projects/creator-projects-builds-customizing.qdoc +++ b/doc/src/projects/creator-projects-builds-customizing.qdoc @@ -31,10 +31,11 @@ \title Customizing the Build Process To specify the relationship between the release, build, - and deploy configurations, select \gui Tools > \gui Options > \gui {Build & Run}. By - default, the \gui {Always build project before deploying it} and the - \gui {Always deploy project before running it} options are enabled. - Therefore, when you select the \gui Run function, \QC checks for changes in + and deploy configurations, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run}. By + default, the \uicontrol {Always build project before deploying it} and the + \uicontrol {Always deploy project before running it} options are enabled. + Therefore, when you select the \uicontrol Run function, \QC checks for changes in the project files and also builds and deploys the project if necessary. \image qtcreator-project-options-deploy.png "Project General Options" diff --git a/doc/src/projects/creator-projects-cmake.qdoc b/doc/src/projects/creator-projects-cmake.qdoc index 274d497975..a5bbc9e446 100644 --- a/doc/src/projects/creator-projects-cmake.qdoc +++ b/doc/src/projects/creator-projects-cmake.qdoc @@ -41,8 +41,8 @@ \section1 Setting the Path for CMake - You can set the path for the \c CMake executable in \gui{Tools} > - \gui{Options > Build & Run > CMake}. + You can set the path for the \c CMake executable in \uicontrol{Tools} > + \uicontrol{Options > Build & Run > CMake}. \image qtcreator-cmakeexecutable.png @@ -66,7 +66,7 @@ \list 1 - \li Select \gui{File} > \gui{Open File or Project}. + \li Select \uicontrol{File} > \uicontrol{Open File or Project}. \li Select the \c{CMakeLists.txt} file from your \c CMake project. @@ -92,10 +92,10 @@ \QC builds \c CMake projects by running \c make, \c mingw32-make, or \c nmake depending on your platform. The build errors and warnings are - parsed and displayed in the \gui{Issues} output pane. + parsed and displayed in the \uicontrol{Issues} output pane. By default, \QC builds the \b{all} target. You can specify which - targets to build in \gui{Project} mode, under \gui{Build Settings}. + targets to build in \uicontrol{Project} mode, under \uicontrol{Build Settings}. \image qtcreator-cmake-build-settings.png @@ -104,7 +104,7 @@ \section1 Running CMake Projects - \QC automatically adds \gui{Run Configurations} for all targets specified + \QC automatically adds \uicontrol{Run Configurations} for all targets specified in the \c CMake project file. For more information about known issues for the current version, see diff --git a/doc/src/projects/creator-projects-compilers.qdoc b/doc/src/projects/creator-projects-compilers.qdoc index 182e799c64..b9f8ffbc75 100644 --- a/doc/src/projects/creator-projects-compilers.qdoc +++ b/doc/src/projects/creator-projects-compilers.qdoc @@ -68,30 +68,30 @@ For QCC, also specify the path to the BlackBerry NDK or the QNX Software Development Platform (SDP). - You specify the compiler to use for each kit in \gui Tools > - \gui Options > \gui {Build & Run} > \gui Kits. + You specify the compiler to use for each kit in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. To add compilers: \list 1 - \li Select \gui {Tools > Options > Build & Run > Compilers > Add} and + \li Select \uicontrol {Tools > Options > Build & Run > Compilers > Add} and select a compiler in the list. \image qtcreator-toolchains.png - To clone the selected compiler, select \gui {Clone}. + To clone the selected compiler, select \uicontrol {Clone}. - \li In the \gui Name column, double-click the name to change it. + \li In the \uicontrol Name column, double-click the name to change it. - \li In the \gui{Compiler path} field, enter the path to the directory + \li In the \uicontrol{Compiler path} field, enter the path to the directory where the compiler is located. - \li In the \gui {Platform codegen flags} field, check the flags passed + \li In the \uicontrol {Platform codegen flags} field, check the flags passed to the compiler that specify the architecture on the target platform. - \li In the \gui {Platform linker flags} field, check the flags passed to + \li In the \uicontrol {Platform linker flags} field, check the flags passed to the linker that specify the architecture on the target platform. The linker flags are used only when building with Qbs. @@ -102,7 +102,7 @@ \section1 Adding Custom Compilers To add a compiler that is not listed above or a remote compiler, use the - \gui Custom option and specify the paths to the directories where the + \uicontrol Custom option and specify the paths to the directories where the compiler and make tool are located and options for the compiler. \image creator-compilers-custom.png @@ -111,55 +111,55 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > - \gui Compilers > \gui Add > \gui Custom. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Compilers > \uicontrol Add > \uicontrol Custom. - \li In the \gui Name field, enter a name for the compiler. + \li In the \uicontrol Name field, enter a name for the compiler. - \li In the \gui {Compiler path} field, enter the path to the directory + \li In the \uicontrol {Compiler path} field, enter the path to the directory where the compiler is located. - \li In the \gui {Make path} field, enter the path to the directory where + \li In the \uicontrol {Make path} field, enter the path to the directory where the make tool is located. - \li In the \gui ABI field, specify the ABI version. + \li In the \uicontrol ABI field, specify the ABI version. - \li In the \gui {Predefined macros} field, specify the macros that the + \li In the \uicontrol {Predefined macros} field, specify the macros that the compiler enables by default. Specify each macro on a separate line, in the following format: MACRO[=value]. - \li In the \gui {Header paths} field, specify the paths to directories + \li In the \uicontrol {Header paths} field, specify the paths to directories that the compiler checks for headers. Specify each path on a separate line. - \li In the \gui {C++11 flags} field, specify the flags that turn on + \li In the \uicontrol {C++11 flags} field, specify the flags that turn on C++11 support in the compiler. - \li In the \gui {Qt mkspecs} field, specify the path to the directory + \li In the \uicontrol {Qt mkspecs} field, specify the path to the directory where mkspecs are located. Usually, the path is specified relative to the Qt mkspecs directory. - \li In the \gui {Error parser} field, select the error parser to use. - Select \gui Custom, and then select \gui {Customer Parser Settings} + \li In the \uicontrol {Error parser} field, select the error parser to use. + Select \uicontrol Custom, and then select \uicontrol {Customer Parser Settings} to specify settings for a custom parser: \image qtcreator-custom-parser.png \list 1 - \li In the \gui {Error message capture pattern} field, specify + \li In the \uicontrol {Error message capture pattern} field, specify a regular expression to define what is an error. The custom parser matches the compile output line by line against the - regular expression and displays errors in the \gui Issues + regular expression and displays errors in the \uicontrol Issues output pane. Create regular expression groups that contain the file name, line number and error message. - \li In the \gui {Capture Positions} field, map the regular - expression groups to \gui {File name}, \gui {Line number}, - and \gui Message. + \li In the \uicontrol {Capture Positions} field, map the regular + expression groups to \uicontrol {File name}, \uicontrol {Line number}, + and \uicontrol Message. - \li In the \gui {Test} group, you can test how the message that - you enter in the \gui {Error message} field is matched when + \li In the \uicontrol {Test} group, you can test how the message that + you enter in the \uicontrol {Error message} field is matched when using the current settings. \endlist @@ -168,7 +168,7 @@ \section1 Troubleshooting MinGW Compilation Errors - If error messages displayed in the \gui {Compile Output} pane contain + If error messages displayed in the \uicontrol {Compile Output} pane contain paths where slashes are missing (for example, C:QtSDK), check your PATH variable. At the command line, enter the following commands: diff --git a/doc/src/projects/creator-projects-creating.qdoc b/doc/src/projects/creator-projects-creating.qdoc index 926770cdb6..c9aa9851c3 100644 --- a/doc/src/projects/creator-projects-creating.qdoc +++ b/doc/src/projects/creator-projects-creating.qdoc @@ -57,7 +57,7 @@ of information are needed to create each configuration. For more information about qmake, see the \l{qmake Manual}. You can modify the build and run settings for qmake projects in the - \gui Projects mode. + \uicontrol Projects mode. You can use wizards also to create plain C or C++ projects that use Qbs or CMake, but do not use the Qt library. @@ -222,10 +222,10 @@ \endlist - To create a new project, select \gui File > \gui{New File or Project} and + To create a new project, select \uicontrol File > \uicontrol{New File or Project} and select the type of your project. The contents of the wizard dialogs depend on the project type and the \l{glossary-buildandrun-kit}{kits} that you select in the - \gui {Kit Selection} dialog. Follow the instructions of the wizard. + \uicontrol {Kit Selection} dialog. Follow the instructions of the wizard. For examples of creating different types of projects, see \l{Tutorials}. @@ -234,11 +234,11 @@ \l {Creating Qt Quick Projects}. To change the location of the project directory, and to specify settings - for building and running projects, select \gui{Tools} > \gui{Options} > - \gui{Build & Run} > \gui{General}. + for building and running projects, select \uicontrol{Tools} > \uicontrol{Options} > + \uicontrol{Build & Run} > \uicontrol{General}. To specify build and run settings for different target platforms, - select \gui Projects. + select \uicontrol Projects. \section1 Adding Files to Projects @@ -264,10 +264,10 @@ application executable \li QML files, which specify items in Qt Quick projects. - \gui {Qt Quick 1} creates a QML file that imports Qt Quick 1.1 and - \gui {Qt Quick 2} creates a QML file that imports Qt Quick 2.0. - Select \gui {Qt Quick 1} to add files to a Qt Quick 1 application - and \gui {Qt Quick 2} to add files to a Qt Quick 2 application. + \uicontrol {Qt Quick 1} creates a QML file that imports Qt Quick 1.1 and + \uicontrol {Qt Quick 2} creates a QML file that imports Qt Quick 2.0. + Select \uicontrol {Qt Quick 1} to add files to a Qt Quick 1 application + and \uicontrol {Qt Quick 2} to add files to a Qt Quick 2 application. \li JavaScript files that you can use to write the application logic in Qt Quick projects @@ -300,19 +300,19 @@ \section2 Creating C++ Classes - The \gui {C++ Class Wizard} allows you to create a C++ header and source + The \uicontrol {C++ Class Wizard} allows you to create a C++ header and source file for a new class that you can add to a C++ project. Specify the class name, base class, and header and source files for the class. The wizard supports namespaces. To use a namespace, enter a qualified - class name in the \gui {Class name} field. For example: + class name in the \uicontrol {Class name} field. For example: MyNamespace::MySubNamespace::MyClass. \image qtcreator-cpp-class-wizard.png "Enter Class Name dialog" The names of the header and source file are based on the class name. To - change the default suffix of a file, select \gui Tools > \gui Options > - \gui {C++} > \gui {File Naming}. + change the default suffix of a file, select \uicontrol Tools > \uicontrol Options > + \uicontrol {C++} > \uicontrol {File Naming}. You can create your own project and class wizards. For more information, see \l{Adding New Custom Wizards}. @@ -339,13 +339,13 @@ \section2 Displaying Additional File Types in Projects Pane \QC determines whether to display files from the project folder - in the \gui Projects pane depending on the file type (.pro, .pri, .cpp, + in the \uicontrol Projects pane depending on the file type (.pro, .pri, .cpp, .h, .qrc, and so on). To display other types of files, edit the project file. Add filenames as values of the \c {DISTFILES} variable. You can also use wildcards. For example, the following code specifies that text files are displayed - in the \gui Projects pane: + in the \uicontrol Projects pane: \code @@ -353,7 +353,7 @@ \endcode - This also makes the files available in the \gui Locator. + This also makes the files available in the \uicontrol Locator. \section1 Adding Subprojects to Projects @@ -366,26 +366,26 @@ system that you use. When you create a new project, you can add it to another project as a - subproject in the \gui{Project Management} dialog. However, the root project + subproject in the \uicontrol{Project Management} dialog. However, the root project must specify that qmake uses the \c subdirs template to build the project. - To create a root project, select \gui {File > New File or Project > + To create a root project, select \uicontrol {File > New File or Project > Other Project > Subdirs Project > Choose}. - On the \gui Summary page, select \gui {Finish & Add Subproject} to create + On the \uicontrol Summary page, select \uicontrol {Finish & Add Subproject} to create the root project and to add another project, such as a C++ library. The wizard creates a project file (.pro) that defines a \c subdirs template and the subproject that you add as a value of the \l{Variables#subdirs} {SUBDIRS variable}. It also adds all the necessary files for the subproject. - To add more subprojects, right-click the project name in the \gui Projects - pane, and select \gui {New Subproject} in the context menu. + To add more subprojects, right-click the project name in the \uicontrol Projects + pane, and select \uicontrol {New Subproject} in the context menu. - To remove subprojects, right-click the project name in the \gui Projects - pane, and select \gui {Remove Subproject} in the context menu. + To remove subprojects, right-click the project name in the \uicontrol Projects + pane, and select \uicontrol {Remove Subproject} in the context menu. - To specify dependencies, use the \gui{Add Library} wizard. For more + To specify dependencies, use the \uicontrol{Add Library} wizard. For more information, see \l{Adding Libraries to Projects}. \section1 Related Topics diff --git a/doc/src/projects/creator-projects-custom-wizards.qdoc b/doc/src/projects/creator-projects-custom-wizards.qdoc index d9c0a72bef..1e4a43b3c4 100644 --- a/doc/src/projects/creator-projects-custom-wizards.qdoc +++ b/doc/src/projects/creator-projects-custom-wizards.qdoc @@ -35,8 +35,8 @@ and classes. You can copy the wizard templates in the template folders to create your own - project and class wizards. They are displayed in the \gui New dialog that - opens when you choose \gui {File > New File or Project}. + project and class wizards. They are displayed in the \uicontrol New dialog that + opens when you choose \uicontrol {File > New File or Project}. 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 @@ -48,8 +48,8 @@ To see how this works, rename wizard_sample.xml as wizard.xml in the \c {\share\qtcreator\templates\wizards\helloworld} and \c {\share\qtcreator\templates\wizards\listmodel} folders. After - you restart \QC, the \gui {Custom Classes} - and \gui {Custom Projects} categories (1) appear in the \gui New dialog. For + you restart \QC, the \uicontrol {Custom Classes} + and \uicontrol {Custom Projects} categories (1) appear in the \uicontrol New dialog. For each category, an icon (2), a display name (3), and a description (4) are displayed. @@ -108,7 +108,7 @@ \li Modify the wizard_example.xml file. \li The following code determines the type of the wizard and its place - in the \gui New dialog: + in the \uicontrol New dialog: \code @@ -137,16 +137,16 @@ \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. + category in the \uicontrol New dialog. \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. + list in the \uicontrol New dialog. \endlist \li The following code specifies the icon and text that appear in the - \gui New dialog: + \uicontrol New dialog: \code @@ -162,8 +162,8 @@ \list - \li \c displayCategory appears in the \gui New dialog, under - \gui Projects. + \li \c displayCategory appears in the \uicontrol New dialog, under + \uicontrol Projects. \li \c icon appears next to the \c displayName in the middle panel when \c displayCategory is selected. @@ -204,7 +204,7 @@ \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 + users specify in the \uicontrol Name field on the first page of the wizard. \li \c openproject indicates that the file is a project file @@ -577,12 +577,12 @@ to \c %Path%. For project wizards, it is \c %Path%/%ProjectName%. \li \c {%CppSourceSuffix%} is replaced by the default source suffix, - which is defined in \QC in \gui {Tools > Options > C++ > + which is defined in \QC in \uicontrol {Tools > Options > C++ > File Naming}. For example, if users enter \b MyClass, the filename becomes myclass.cpp when the project is created. \li \c {%CppHeaderSuffix%} is replaced by the default header suffix, - which is also defined in \gui {File Naming}. + which is also defined in \uicontrol {File Naming}. \li \c {%CurrentDate%} is replaced by the current date in the format \c {YYYY-MM-DD} as specified by ISO 8601. diff --git a/doc/src/projects/creator-projects-debuggers.qdoc b/doc/src/projects/creator-projects-debuggers.qdoc index 514a1c8b43..1382274788 100644 --- a/doc/src/projects/creator-projects-debuggers.qdoc +++ b/doc/src/projects/creator-projects-debuggers.qdoc @@ -37,19 +37,19 @@ The debugger plugin automatically selects a suitable native debugger for each \l{glossary-buildandrun-kit}{kit} from the ones found on your system. - To override this choice, select \gui Tools > \gui Options > - \gui {Build & Run} > \gui Kits. + To override this choice, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol Kits. To add debuggers: \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > - \gui Debuggers > \gui Add. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Debuggers > \uicontrol Add. - \li In the \gui Name field, give a descriptive name for the debugger. + \li In the \uicontrol Name field, give a descriptive name for the debugger. - \li In the \gui Path field, specify the path to the debugger binary: + \li In the \uicontrol Path field, specify the path to the debugger binary: \list @@ -78,7 +78,7 @@ \endlist - \li In the \gui ABIs field, specify the ABI versions to use on embedded + \li In the \uicontrol ABIs field, specify the ABI versions to use on embedded devices. \endlist diff --git a/doc/src/projects/creator-projects-generic.qdoc b/doc/src/projects/creator-projects-generic.qdoc index 51af31f7eb..1cc9701f1f 100644 --- a/doc/src/projects/creator-projects-generic.qdoc +++ b/doc/src/projects/creator-projects-generic.qdoc @@ -32,7 +32,7 @@ Generic project support allows you to use \QC as a code editor. You can change the way your project is built by modifying the \c make command - in the \gui{Projects} mode under \gui{Build Settings}. + in the \uicontrol{Projects} mode under \uicontrol{Build Settings}. When you import a project, \QC creates the following files that allow you to specify which files belong to your project and which include @@ -45,10 +45,10 @@ \list 1 - \li Select \gui File > \gui{New File or Project} > \gui{Import Project} - > \gui{Import Existing Project}. + \li Select \uicontrol File > \uicontrol{New File or Project} > \uicontrol{Import Project} + > \uicontrol{Import Existing Project}. - \li In \gui{Import Existing Project}, enter the project name + \li In \uicontrol{Import Existing Project}, enter the project name and select the location of the project file you want to import. \QC automatically generates the following files in the @@ -96,7 +96,7 @@ is modified externally, you have to restart \QC for the changes to take effect. - To update the \tt{.files} on the \gui Git repository use the following + To update the \tt{.files} on the \uicontrol Git repository use the following script: \code @@ -123,12 +123,12 @@ \QC cannot automatically determine which executable to run. - In the \gui{Projects} mode under \gui{Run Settings}, define the executable + In the \uicontrol{Projects} mode under \uicontrol{Run Settings}, define the executable file to run: \list 1 - \li Click \gui Add and select \gui{Custom Executable}. + \li Click \uicontrol Add and select \uicontrol{Custom Executable}. \li Define the configuration name, the location of the executable, any additional arguments and the working directory. diff --git a/doc/src/projects/creator-projects-libraries.qdoc b/doc/src/projects/creator-projects-libraries.qdoc index 2c63ad5d29..c1a4fa3395 100644 --- a/doc/src/projects/creator-projects-libraries.qdoc +++ b/doc/src/projects/creator-projects-libraries.qdoc @@ -56,8 +56,8 @@ (PRE_TARGETDEPS) in the project file. Depending on the development platform, some options might be detected - automatically. For example, on OS X, the library type (\gui Library or - \gui Framework) is detected automatically and the option is hidden. However, + automatically. For example, on OS X, the library type (\uicontrol Library or + \uicontrol Framework) is detected automatically and the option is hidden. However, if you develop on another platform than OS X and want to build your project for OS X, you must specify the library type. @@ -71,7 +71,7 @@ debug version. For example, if the release version is called example.lib, the debug version is called exampled.lib. You can specify that the letter is added for the debug version and removed for the release version. - If the library name ends in \e d, deselect the \gui {Remove "d" suffix + If the library name ends in \e d, deselect the \uicontrol {Remove "d" suffix for release version} option. \QC supports code completion and syntax highlighting for the added @@ -81,9 +81,9 @@ \list 1 - \li In the \gui Projects pane, right-click the project name to open the + \li In the \uicontrol Projects pane, right-click the project name to open the context menu and select - \gui {Add Library}. + \uicontrol {Add Library}. \li Follow the instructions of the wizard. @@ -99,29 +99,29 @@ \list 1 - \li Choose \gui {File > New File or Project > Libraries > + \li Choose \uicontrol {File > New File or Project > Libraries > C++ Library} to create the library. - The \gui {Introduction and Product Location} dialog opens. + The \uicontrol {Introduction and Product Location} dialog opens. \image qtcreator-add-library-wizard-ex-1.png "Introduction and Product Location dialog" - \li In the \gui Type field, select \gui {Statically Linked Library}. + \li In the \uicontrol Type field, select \uicontrol {Statically Linked Library}. - \li In the \gui Name field, give a name for the library. For example, + \li In the \uicontrol Name field, give a name for the library. For example, \b mylib. \li Follow the instructions of the wizard until you get to the - \gui {Project Management} dialog. In the \gui {Add to project} + \uicontrol {Project Management} dialog. In the \uicontrol {Add to project} list, select a project. For example, \b myapp. - \li In the \gui Projects pane, right-click the project name to open the + \li In the \uicontrol Projects pane, right-click the project name to open the context menu and select - \gui {Add Library > Internal Library > Next}. + \uicontrol {Add Library > Internal Library > Next}. - \li In the \gui Library field, select \b mylib and click \gui Next. + \li In the \uicontrol Library field, select \b mylib and click \uicontrol Next. - \li Click \gui Finish to add the following library declaration to the + \li Click \uicontrol Finish to add the following library declaration to the project file: \code diff --git a/doc/src/projects/creator-projects-opening.qdoc b/doc/src/projects/creator-projects-opening.qdoc index 47ebb6347d..4515e4be65 100644 --- a/doc/src/projects/creator-projects-opening.qdoc +++ b/doc/src/projects/creator-projects-opening.qdoc @@ -35,19 +35,19 @@ to enter the information. If you created the project by using another \QC instance, \QC asks whether you want to use the old settings. The settings are specific to the development environment, and should not be copied from - one environment to another. Therefore, we recommend that you click \gui No - and enter the information again in the \gui {Configure Project} tab. + one environment to another. Therefore, we recommend that you click \uicontrol No + and enter the information again in the \uicontrol {Configure Project} tab. - The \gui {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} + The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} for building and running projects, that are installed on the development PC and - configured in \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits. + configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. Select the kits that you want to build and run the project with. \image qtcreator-open-project-kits.png "Configure Project tab" Even if you do not intend to build the project, the C++ and QML code models need a Qt version and compiler to offer code completion. To specify them, - select the \gui Options link, or select \gui {Tools > Options > Build & Run + select the \uicontrol Options link, or select \uicontrol {Tools > Options > Build & Run > Kits}. If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, @@ -59,7 +59,7 @@ If you have built the project before, \QC can use the existing build configuration to make the exact same build as found in the directory available to \QC. To import a build, specify a directory in the - \gui {Import Build from} section and select \gui {Import}. + \uicontrol {Import Build from} section and select \uicontrol {Import}. You can edit the build configuration later. For more information, see \l{Editing Build Configurations}. @@ -68,11 +68,11 @@ \list 1 - \li Select \gui File > \gui{Open File or Project} and select the project + \li Select \uicontrol File > \uicontrol{Open File or Project} and select the project to open. - \li In the \gui {Configure Project} tab, select kits for building and running your - project, and click \gui {Configure Project}. + \li In the \uicontrol {Configure Project} tab, select kits for building and running your + project, and click \uicontrol {Configure Project}. \endlist @@ -80,7 +80,7 @@ analysis to build up the information that it needs for functions such as navigation and finding usages. A progress bar is displayed during parsing. To show or hide detailed progress information, select - \gui {Toggle Progress Details} (1). + \uicontrol {Toggle Progress Details} (1). \image creator-toggle-progress-bar.png "Toggle Progress Details button" diff --git a/doc/src/projects/creator-projects-qbs.qdoc b/doc/src/projects/creator-projects-qbs.qdoc index a43fd260a6..29379acc30 100644 --- a/doc/src/projects/creator-projects-qbs.qdoc +++ b/doc/src/projects/creator-projects-qbs.qdoc @@ -49,9 +49,9 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > \gui {Plain C - Project (Qbs Build)} or \gui {Plain C++ Project (Qbs Build)} > - \gui Choose, and follow the instructions of the wizard to create a + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol {Plain C + Project (Qbs Build)} or \uicontrol {Plain C++ Project (Qbs Build)} > + \uicontrol Choose, and follow the instructions of the wizard to create a Qbs project. \image creator-qbs-project.png @@ -60,24 +60,24 @@ \c Depends item for a Qt application. For examples, see the \c {examples} directory in the qbs repository. - \li Select \gui Projects to specify \gui {Build Settings} for the + \li Select \uicontrol Projects to specify \uicontrol {Build Settings} for the project. - \li Select \gui {Build Steps} > \gui Details to specify build steps: + \li Select \uicontrol {Build Steps} > \uicontrol Details to specify build steps: \image creator-qbs-build-app.png \list 1 - \li In the \gui {Build variant} field, select \gui Debug to + \li In the \uicontrol {Build variant} field, select \uicontrol Debug to include debug symbols in the build for debugging the - application and \gui Release to create the final + application and \uicontrol Release to create the final installation file. - \li In the \gui {Parallel jobs} field, specify the number of + \li In the \uicontrol {Parallel jobs} field, specify the number of parallel jobs to use for building. - \li Select the \gui {Enable QML debugging} check box to debug + \li Select the \uicontrol {Enable QML debugging} check box to debug Qt Quick application projects. \note Debugging requires opening a socket at a well-known @@ -86,56 +86,56 @@ execute any JavaScript functions. Therefore, you must make sure that the port is properly protected by a firewall. - \li In the \gui Properties field, specify the properties to pass + \li In the \uicontrol Properties field, specify the properties to pass to the project. Use colons (:) to separate keys from values. For more information, see \l{http://qt-project.org/doc/qbs/language-introduction.html} {Modules} in the Qbs Manual. - \li In the \gui Flags field: + \li In the \uicontrol Flags field: \list - \li Select \gui {Dry run} to test building without + \li Select \uicontrol {Dry run} to test building without executing commands or making permanent changes to the build graph. - \li Select \gui {Keep going} to continue building when + \li Select \uicontrol {Keep going} to continue building when errors occur, if possible. \endlist \endlist - The \gui {Equivalent command line} field displays the build command + The \uicontrol {Equivalent command line} field displays the build command that is constructed based on the selected options. - \li Select \gui {Clean Steps} > \gui Details to specify flags for the + \li Select \uicontrol {Clean Steps} > \uicontrol Details to specify flags for the cleaning step. \image creator-qbs-build-clean.png \list - \li Select \gui {Clean all artifacts} to remove all build + \li Select \uicontrol {Clean all artifacts} to remove all build artifacts. - \li Select \gui {Dry run} to test cleaning without executing + \li Select \uicontrol {Dry run} to test cleaning without executing commands or making permanent changes to the build graph. - \li Select \gui {Keep going} to continue cleaning when errors + \li Select \uicontrol {Keep going} to continue cleaning when errors occur, if possible. \endlist - The \gui {Equivalent command line} field displays the clean command + The \uicontrol {Equivalent command line} field displays the clean command that is constructed based on the selected options. - \li Select \gui Build > \gui {Build Project} to build the application. + \li Select \uicontrol Build > \uicontrol {Build Project} to build the application. \li Click the \inlineimage qtcreator-run.png - (\gui Run) button to deploy and run the application. + (\uicontrol Run) button to deploy and run the application. \endlist */ diff --git a/doc/src/projects/creator-projects-qt-versions.qdoc b/doc/src/projects/creator-projects-qt-versions.qdoc index 293191a001..0f1b0f7351 100644 --- a/doc/src/projects/creator-projects-qt-versions.qdoc +++ b/doc/src/projects/creator-projects-qt-versions.qdoc @@ -37,13 +37,13 @@ \QC automatically detects the Qt versions that are registered by your system or by installers. To view detailed information for each Qt - version, select it in the list and select \gui Details in the - \gui {Qt version for} section. To add Qt versions, select - \gui {Tools > Options > Build & Run > Qt Versions}. + version, select it in the list and select \uicontrol Details in the + \uicontrol {Qt version for} section. To add Qt versions, select + \uicontrol {Tools > Options > Build & Run > Qt Versions}. You specify the Qt version to use for each \l{glossary-buildandrun-kit} {kit} for building and running your projects - in \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits. + in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. \section2 Setting Up New Qt Versions @@ -51,7 +51,7 @@ \list 1 - \li Select \gui {Tools > Options > Build & Run > Qt Versions > Add}. + \li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add}. \li Select the qmake executable for the Qt version that you want to add. @@ -60,13 +60,13 @@ \image qtcreator-qt4-qtversions-add.png - \li In the \gui{Version name} field, edit the name that \QC + \li In the \uicontrol{Version name} field, edit the name that \QC suggests for the Qt version. - \li In the \gui{qmake location} field, you can change the qmake + \li In the \uicontrol{qmake location} field, you can change the qmake location. - \li In the \gui Helpers section, select \gui Details to view the + \li In the \uicontrol Helpers section, select \uicontrol Details to view the QML Dumper that has been built for the Qt version. For more information, see \l{Using Debugging Helpers}. @@ -74,7 +74,7 @@ \li If the Qt version is for Blackberry or QNX, enter the path to your installed Blackberry NDK or QNX SDK in the - \gui {Blackberry Native SDK} or \gui{QNX SDK} field respectively. + \uicontrol {Blackberry Native SDK} or \uicontrol{QNX SDK} field respectively. \endlist diff --git a/doc/src/projects/creator-projects-running.qdoc b/doc/src/projects/creator-projects-running.qdoc index 48d7866f64..1fb2c27e7a 100644 --- a/doc/src/projects/creator-projects-running.qdoc +++ b/doc/src/projects/creator-projects-running.qdoc @@ -34,22 +34,22 @@ location from where it can be run on the desktop, on a device emulator or simulator, or on a mobile device that is connected to the development PC. - To run executable files without deploying them first, select \gui Build > - \gui {Run Without Deployment}. To make this the default option, deselect the - \gui Tools > \gui Options > \gui Project > - \gui {Always deploy project before running it} option. + To run executable files without deploying them first, select \uicontrol Build > + \uicontrol {Run Without Deployment}. To make this the default option, deselect the + \uicontrol Tools > \uicontrol Options > \uicontrol Project > + \uicontrol {Always deploy project before running it} option. To run applications: \list 1 - \li Click the \gui {Build and Run Kit Selector} icon (1) or select - \gui Build > \gui {Open Build and Run Kit Selector} to select the + \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select + \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the build and run \l{glossary-buildandrun-kit}{kit}. \image qtcreator-kit-selector.png "Kit selector" - \li Click the \gui Run button (2). + \li Click the \uicontrol Run button (2). \endlist diff --git a/doc/src/projects/creator-projects-settings-build.qdoc b/doc/src/projects/creator-projects-settings-build.qdoc index dff2078bbf..52d12c7684 100644 --- a/doc/src/projects/creator-projects-settings-build.qdoc +++ b/doc/src/projects/creator-projects-settings-build.qdoc @@ -38,17 +38,17 @@ configuration for testing and the release configuration for creating the final installation file. - You specify build settings in the \gui Projects mode. - To add a new build configuration, click \gui Add and select the type of + You specify build settings in the \uicontrol Projects mode. + To add a new build configuration, click \uicontrol Add and select the type of configuration you would like to add. You can add as many build configurations as you need. - To delete the build configuration currently selected, click \gui Remove. + To delete the build configuration currently selected, click \uicontrol Remove. \section1 Editing Build Configurations Select the build configuration to edit in the - \gui {Edit build configuration} field. + \uicontrol {Edit build configuration} field. \image qtcreator-projectpane.png @@ -56,12 +56,13 @@ directory, as \l{glossary-shadow-build} {shadow builds}. This keeps the files generated for each \l{glossary-buildandrun-kit}{build and run kit} separate. If you only build and run with a single \l{glossary-buildandrun-kit}{kit}, - you can deselect the \gui {Shadow build} + you can deselect the \uicontrol {Shadow build} checkbox. To make in-source builds the default option for all projects, select - \gui Tools > \gui Options > \gui {Build & Run} > \gui General, and enter a - period (.) in the \gui {Default build directory} field. + \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol General, and enter a period (.) in the + \uicontrol {Default build directory} field. \section1 Starting External Processes @@ -70,26 +71,26 @@ commands that are native to the system. It constructs the commands from an executable name and optional command line arguments. - The executable name is specified in the executable fields: \gui qmake, - \gui Make, \gui Command, or \gui Executable. It is either derived from the + The executable name is specified in the executable fields: \uicontrol qmake, + \uicontrol Make, \uicontrol Command, or \uicontrol Executable. It is either derived from the project or specified manually. When you specify executables manually, you can reference environment variables and \QC variables. However, no quoting rules apply. You can specify command-line arguments in the arguments fields: - \gui {Additional arguments}, \gui {Command arguments}, - \gui {Make arguments}, or \gui Arguments. You can create shell command lines + \uicontrol {Additional arguments}, \uicontrol {Command arguments}, + \uicontrol {Make arguments}, or \uicontrol Arguments. You can create shell command lines that can contain redirection and other advanced constructs. However, some more complex use cases, such as piping test data into the application being tested or grouping commands, are not supported because the value of the - \gui Executable field is always placed first when constructing the command. + \uicontrol Executable field is always placed first when constructing the command. \section2 Using Environment Variables You can use any environment variables as values in the fields. For a list - of variable names, click \gui {Build Environment > Details} in the - \gui {Build Settings}. Environment variables are referenced using the native + of variable names, click \uicontrol {Build Environment > Details} in the + \uicontrol {Build Settings}. Environment variables are referenced using the native syntax: $VARNAME or ${VARNAME} on Unix and %VARNAME% on Windows. \section2 Using Qt Creator Variables @@ -98,12 +99,12 @@ directories. The variables take care of quoting their expansions, so you do not need to put them in quotes. Select the \inlineimage qtcreator-variables-button.png - (\gui {Variables}) button in a field to select from a list of variables that + (\uicontrol {Variables}) button in a field to select from a list of variables that are available in a particular context. \section1 Build Steps - The build system of \QC is built on qmake and make. In \gui{Build Steps} you + The build system of \QC is built on qmake and make. In \uicontrol{Build Steps} you can change the settings for qmake and make. \QC runs the make command using the Qt version defined for the current build configuration. @@ -120,19 +121,19 @@ deploy QML files together with the application. \QC new project wizards create projects that the Qt Quick Compiler can compile, because they are set up to use the Qt Resource System. To compile Qt Quick projects, select - the \gui {Enable Qt Quick Compiler} check box. + the \uicontrol {Enable Qt Quick Compiler} check box. \note For more information about the build steps when using Qbs, see \l{Building Applications with Qbs}. \section2 Adding Custom Build Steps - To add custom steps to the build settings, select \gui {Add Build Step > + To add custom steps to the build settings, select \uicontrol {Add Build Step > Custom Process Step}. By default, custom steps are enabled. To disable a custom step, select the \inlineimage qtcreator-disable-steps.png - (\gui Disable) button. + (\uicontrol Disable) button. \image qtcreator-build-steps-custom.png "Custom Process Step" @@ -144,21 +145,21 @@ \image qtcreator-clean-steps.png "Clean steps" - You can define the cleaning steps for your builds in the \gui{Clean Steps}: + You can define the cleaning steps for your builds in the \uicontrol{Clean Steps}: \list \li To add a clean step using make or a custom process, click - \gui{Add Clean Step} and select the type of step you want to add. + \uicontrol{Add Clean Step} and select the type of step you want to add. By default, custom steps are enabled. To disable a custom step, - select the \gui Disable button. + select the \uicontrol Disable button. - \li To remove a clean step, click \gui{Remove Item}. + \li To remove a clean step, click \uicontrol{Remove Item}. \li To change the order of steps, click \inlineimage qtcreator-movestep.png - (\gui {Move Up} and \gui {Move Down}). + (\uicontrol {Move Up} and \uicontrol {Move Down}). \endlist \note For more information about the cleaning steps when using Qbs, see @@ -167,7 +168,7 @@ \section1 Build Environment You can specify the environment you want to use for building in the - \gui {Build Environment} section. By default, the environment in which \QC + \uicontrol {Build Environment} section. By default, the environment in which \QC was started is used and modified to include the Qt version. Depending on the selected Qt version, \QC automatically sets the necessary environment variables. You can edit existing environment @@ -184,8 +185,8 @@ \section2 Batch Editing To modify environment variable values for build or run environments, - select \gui {Batch Edit} in the build or run settings and enter environment - variables in the \gui {Edit Environment} dialog. + select \uicontrol {Batch Edit} in the build or run settings and enter environment + variables in the \uicontrol {Edit Environment} dialog. To remove a variable value from the environment, enter the variable name. For example, \c TEST sets the value of the \c TEST variable empty when @@ -204,7 +205,7 @@ \section2 Clearing the System Environment - To build with a clean system environment, select the \gui {Clear system + To build with a clean system environment, select the \uicontrol {Clear system environment} check box. \QC discards the current environment, and populates a clean system environment with the environment variables that the compilers and tools need. Therefore, the environment is never totally empty, diff --git a/doc/src/projects/creator-projects-settings-code-style.qdoc b/doc/src/projects/creator-projects-settings-code-style.qdoc index 379df033b6..e9bcb48741 100644 --- a/doc/src/projects/creator-projects-settings-code-style.qdoc +++ b/doc/src/projects/creator-projects-settings-code-style.qdoc @@ -32,7 +32,7 @@ \QC uses the \l{Editing MIME Types}{MIME type} of the file to determine which mode and editor to use for opening the file. - \QC opens C++ files in \gui Edit mode in the C++ code editor and + \QC opens C++ files in \uicontrol Edit mode in the C++ code editor and QML files in the Qt Quick editor. You can configure the code style according to your needs. You can specify @@ -42,29 +42,29 @@ settings. To specify global code style settings sets for C++ files, select - \gui {Tools > Options > C++}. + \uicontrol {Tools > Options > C++}. - To specify global code style settings sets for QML files, select \gui {Tools + To specify global code style settings sets for QML files, select \uicontrol {Tools > Options > Qt Quick}. To configure the editor behavior for the current project: \list 1 - \li Select \gui Projects > \gui {Code Style}. + \li Select \uicontrol Projects > \uicontrol {Code Style}. - \li In the \gui Language field, select \gui C++ or \gui {Qt Quick}. + \li In the \uicontrol Language field, select \uicontrol C++ or \uicontrol {Qt Quick}. - \li In the \gui {Current settings} field, select the settings to modify - and click \gui Copy. + \li In the \uicontrol {Current settings} field, select the settings to modify + and click \uicontrol Copy. - \li Give a name to the settings and click \gui OK. + \li Give a name to the settings and click \uicontrol OK. - \li Click \gui Edit to specify code style settings for the project. + \li Click \uicontrol Edit to specify code style settings for the project. \image qtcreator-code-style-settings-edit-cpp.png "Edit Code Style Settings dialog" - \note Only \gui General settings are available for QML files. + \note Only \uicontrol General settings are available for QML files. \image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings view" diff --git a/doc/src/projects/creator-projects-settings-dependencies.qdoc b/doc/src/projects/creator-projects-settings-dependencies.qdoc index d0f2b410e6..d18f607e86 100644 --- a/doc/src/projects/creator-projects-settings-dependencies.qdoc +++ b/doc/src/projects/creator-projects-settings-dependencies.qdoc @@ -44,9 +44,9 @@ \list 1 - \li In \gui Projects, select a project. + \li In \uicontrol Projects, select a project. - \li Click \gui Dependencies. + \li Click \uicontrol Dependencies. \li Select projects that must be built before the current project is built. diff --git a/doc/src/projects/creator-projects-settings-editor.qdoc b/doc/src/projects/creator-projects-settings-editor.qdoc index fad668df10..9365227037 100644 --- a/doc/src/projects/creator-projects-settings-editor.qdoc +++ b/doc/src/projects/creator-projects-settings-editor.qdoc @@ -32,20 +32,20 @@ \QC uses the \l{Editing MIME Types}{MIME type} of the file to determine which mode and editor to use for opening the file. For example, - \QC opens .txt files in \gui Edit mode in the text editor. + \QC opens .txt files in \uicontrol Edit mode in the text editor. You can configure the text editor according to your needs. You can specify editor behavior either globally for all projects or separately for each - project. To specify global editor behavior, select \gui {Tools > Options + project. To specify global editor behavior, select \uicontrol {Tools > Options > Text Editor > Behavior}. To configure the text editor behavior for the current project: \list 1 - \li Select \gui Projects > \gui Editor. + \li Select \uicontrol Projects > \uicontrol Editor. - \li In the \gui {Editor Settings} field, select \gui {Custom}. + \li In the \uicontrol {Editor Settings} field, select \uicontrol {Custom}. \li Specify text editor settings for the project. @@ -53,7 +53,7 @@ \image qtcreator-editor-settings.png "Editor view" - Click \gui {Restore Global} to revert to the global settings. + Click \uicontrol {Restore Global} to revert to the global settings. For more information about the settings, see: diff --git a/doc/src/projects/creator-projects-settings-overview.qdoc b/doc/src/projects/creator-projects-settings-overview.qdoc index 28c3edfc01..e55a20ce5c 100644 --- a/doc/src/projects/creator-projects-settings-overview.qdoc +++ b/doc/src/projects/creator-projects-settings-overview.qdoc @@ -35,19 +35,19 @@ automatically in \QC. To view and modify the settings for currently open projects, switch to the - \gui Projects mode by pressing \key Ctrl+5. + \uicontrol Projects mode by pressing \key Ctrl+5. You can select build and run \l{glossary-buildandrun-kit}{kits} for the - open projects and use the \gui Build menu commands to build, deploy, and + open projects and use the \uicontrol Build menu commands to build, deploy, and run projects. \section1 Selecting Kits \image qtcreator-project-kits.png - To add kits for the project, select \gui {Add Kit}. The list displays kits - that are configured in \gui Tools > \gui Options > \gui {Build & Run} > - \gui Kits. To add kits to the list, select \gui {Manage Kits}. + To add kits for the project, select \uicontrol {Add Kit}. The list displays kits + that are configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Kits. To add kits to the list, select \uicontrol {Manage Kits}. For more information about adding kits, see \l{Adding Kits}. Each kit consists of a set of values that define one environment, such as a @@ -55,12 +55,12 @@ \l{Adding Qt Versions}, \l{Adding Compilers}, and \l{Adding Debuggers}. To copy the build and run settings for a kit to another kit, select - \gui {Copy to Kit} in the kit menu. + \uicontrol {Copy to Kit} in the kit menu. To change the kit, while preserving the build and run settings, select - \gui {Change Kit}. + \uicontrol {Change Kit}. - To remove a kit, select \gui {Remove Kit}. + To remove a kit, select \uicontrol {Remove Kit}. \section1 Specifying Settings @@ -79,7 +79,7 @@ \endlist \note If you have not configured the project for building, the - \gui {Build & Run} tab is replaced by the \l{Opening Projects} + \uicontrol {Build & Run} tab is replaced by the \l{Opening Projects} {Configure Projects} tab. \li \l{Specifying Editor Settings}{Editor Settings} @@ -90,7 +90,7 @@ \endlist - Use the \gui Build and \gui Run buttons to switch between the build and + Use the \uicontrol Build and \uicontrol Run buttons to switch between the build and run settings for the active project. If you have multiple projects open in \QC, use the tabs at the top of the diff --git a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc index 62d1b14fd8..956b7c8f59 100644 --- a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc @@ -11,7 +11,7 @@ \list 1 - \li In the \gui {Valgrind Settings} section, select \gui Custom. + \li In the \uicontrol {Valgrind Settings} section, select \uicontrol Custom. \li Specify Valgrind settings for the project. @@ -29,8 +29,8 @@ \endlist - Click \gui {Restore Global} to revert to the global settings. + Click \uicontrol {Restore Global} to revert to the global settings. - To specify global Valgrind settings, select \gui {Tools > Options > + To specify global Valgrind settings, select \uicontrol {Tools > Options > Analyzer}. diff --git a/doc/src/projects/creator-projects-settings-run-debug.qdocinc b/doc/src/projects/creator-projects-settings-run-debug.qdocinc index 6e488a4af5..a871717af8 100644 --- a/doc/src/projects/creator-projects-settings-run-debug.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-debug.qdocinc @@ -2,8 +2,8 @@ \image qtquick-debugging-settings.png "Debugger Settings" - To select the languages to debug, select the \gui {Enable C++} and - \gui {Enable QML} check boxes. The \gui {Debug port} is the port to + To select the languages to debug, select the \uicontrol {Enable C++} and + \uicontrol {Enable QML} check boxes. The \uicontrol {Debug port} is the port to communicate with the debugger. You can use any free port in the registered or dynamic port range. @@ -14,6 +14,6 @@ If you debug more than one application at a time, you might receive an error message stating that the port is already in use. Specify a free port number - in \gui {Debug port} and try again. + in \uicontrol {Debug port} and try again. For more information about debugging, see \l{Debugging}. diff --git a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc index a8f7a37d69..9eb32e1a9e 100644 --- a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc @@ -4,13 +4,13 @@ and the working directory to use. The working directory defaults to the directory of the build result. - For console applications, check the \gui{Run in Terminal} check box. + For console applications, check the \uicontrol{Run in Terminal} check box. If you need to run with special environment variables set up, you also do it in the run configuration settings. \image qtcreator-pprunsettings.png - The \gui {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option + The \uicontrol {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option (only available on OS X) enables you to debug (for example, step into) linked frameworks, such as the Qt framework itself. You do not need this option for debugging your application code. diff --git a/doc/src/projects/creator-projects-settings-run.qdoc b/doc/src/projects/creator-projects-settings-run.qdoc index b2e072dcb8..d62baa1132 100644 --- a/doc/src/projects/creator-projects-settings-run.qdoc +++ b/doc/src/projects/creator-projects-settings-run.qdoc @@ -31,12 +31,12 @@ \title Specifying Run Settings \QC automatically creates run configurations for your project. - To view and modify the settings, select \gui {Projects > Build & Run > Run}. + To view and modify the settings, select \uicontrol {Projects > Build & Run > Run}. The settings to specify depend on the type of the project and on the \l{glossary-buildandrun-kit}{kit} that you build and run the project with. - Click \gui Add to add run settings for a project and \gui Remove to remove + Click \uicontrol Add to add run settings for a project and \uicontrol Remove to remove the current settings. \section1 Specifying Run Settings for qmake Projects @@ -64,31 +64,31 @@ \QC automatically selects the environment used for running the application based on the device type. You can edit the environment or select another - environment in the \gui {Run Environment} section. + environment in the \uicontrol {Run Environment} section. You can edit existing environment variables or add, reset and unset new variables. \image qtcreator-run-environment.png "Run Environment section" - When running on the desktop, the \gui {Build Environment} is used by - default, but you can also use the \gui {System Environment} without the + When running on the desktop, the \uicontrol {Build Environment} is used by + default, but you can also use the \uicontrol {System Environment} without the additions made to the build environment. For more information, see \l {Build Environment}. - To run in a clean system environment, select \gui {Clean Environment}. + To run in a clean system environment, select \uicontrol {Clean Environment}. When running on a mobile device connected to the development host, \QC - fetches information about the \gui {Device Environment} from the device. + fetches information about the \uicontrol {Device Environment} from the device. Usually, it does not make sense to edit the device environment. To modify the environment variable values for the run environment, select - \gui {Batch Edit}. For more information, see \l{Batch Editing}. + \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}. \section1 Specifying a Custom Executable to Run If you use CMake or the generic project type in \QC, or want - to run a custom desktop executable, create a \gui {Custom Executable} + to run a custom desktop executable, create a \uicontrol {Custom Executable} run configuration for your project. For example, when working on a library, you can run a test application that links against the library. diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc index 3b6926d48c..1a523141ba 100644 --- a/doc/src/projects/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -62,16 +62,16 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits - > \gui Add. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} + > \uicontrol Kits > \uicontrol Add. \image qtcreator-kits.png - To clone the selected kit, select \gui Clone. + To clone the selected kit, select \uicontrol Clone. - \li In the \gui Name column, double-click the kit name to change it. + \li In the \uicontrol Name column, double-click the kit name to change it. - \li In the \gui{Device type} field, select the type of the device. + \li In the \uicontrol{Device type} field, select the type of the device. Double-click the icon next to the field to select the image that is displayed in the kit selector for this kit. You can use any @@ -80,29 +80,29 @@ logo as an icon allows you to easily see, which compiler is used to build the project for the selected kit. - \li In the \gui Device field, select a device. + \li In the \uicontrol Device field, select a device. - \li In the \gui Sysroot field, specify the directory where the device + \li In the \uicontrol Sysroot field, specify the directory where the device image is located. If you are not cross-compiling, leave this field empty. - \li In the \gui {Compiler} field, select the compiler required + \li In the \uicontrol {Compiler} field, select the compiler required to build the project. You can add compilers to the list if they are installed on the development PC, but were not detected automatically. For more information, see \l{Adding Compilers}. - \li In the \gui Environment field, select \gui Change to modify + \li In the \uicontrol Environment field, select \uicontrol Change to modify environment variable values for build and run environments in - the \gui {Edit Environment Changes} dialog. For more information + the \uicontrol {Edit Environment Changes} dialog. For more information about how to add and remove variable values, see \l{Batch Editing}. - \li In the \gui Debugger field, select the debugger to debug the project + \li In the \uicontrol Debugger field, select the debugger to debug the project on the target platform. \QC automatically detects available debuggers and displays a suitable debugger in the field. You can add debuggers to the list. For more information, see \l{Adding Debuggers}. - \li In the \gui {Qt version} field, select the Qt version to use for + \li In the \uicontrol {Qt version} field, select the Qt version to use for building the project. You can add Qt versions to the list if they are installed on the development PC, but were not detected automatically. For more information, see \l{Adding Qt Versions}. @@ -110,9 +110,9 @@ \QC checks the directories listed in the \c{PATH} environment variable for the qmake executable. If a qmake executable is found, it is referred to as \b{Qt in PATH} and selected as the Qt - version to use for the \gui Desktop kit that is created by default. + version to use for the \uicontrol Desktop kit that is created by default. - \li In the \gui {Qt mkspec} field, specify the name of the mkspec + \li In the \uicontrol {Qt mkspec} field, specify the name of the mkspec configuration that should be used by qmake. If you leave this field empty, the default mkspec of the selected Qt version is used. |