Commit e1fbeedc authored by Leena Miettinen's avatar Leena Miettinen Committed by Leena Miettinen

Doc: use \uicontrol command instead of \gui macro

Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: default avatarTopi Reiniö <topi.reinio@digia.com>
parent c9696aa6
......@@ -30,20 +30,20 @@
\title Analyzing Code
You can use the code analysis tools in the \gui Analyze mode. To switch to
\gui Analyze mode, select \gui Analyze in the mode selector, or select the
\gui {Analyze} menu and then select a tool. When you are in the
\gui Analyze mode, you can switch between tools by selecting them in the
You can use the code analysis tools in the \uicontrol Analyze mode. To switch to
\uicontrol Analyze mode, select \uicontrol Analyze in the mode selector, or
select the \uicontrol {Analyze} menu and then select a tool. When you are in the
\uicontrol Analyze mode, you can switch between tools by selecting them in the
menu on the toolbar.
\image qtcreator-analyze-menu.png "Analyze mode menu"
You can drag and drop the views in the \gui Analyze mode to new positions
You can drag and drop the views in the \uicontrol Analyze mode to new positions
on the screen. The size and position of views are saved for future
sessions. Select \gui {Window > Views > Reset to Default Layout} to reset
sessions. Select \uicontrol {Window > Views > Reset to Default Layout} to reset
the views to their original sizes and positions.
You can use the following code analysis tools in the \gui Analyze mode:
You can use the following code analysis tools in the \uicontrol Analyze mode:
\list
......
......@@ -48,14 +48,15 @@
\list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Code Analyzer} >
\gui {Clang Static Analyzer} to enable the experimental plugin.
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Code Analyzer} > \uicontrol {Clang Static Analyzer} to
enable the experimental plugin.
\li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Analyzer >
\gui {Clang Static Analyzer} to check that the path to the Clang
executable is set correctly in the \gui {Clang executable} field.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer >
\uicontrol {Clang Static Analyzer} to check that the path to the Clang
executable is set correctly in the \uicontrol {Clang executable} field.
\image qtcreator-clang-static-analyzer-options.png
......@@ -65,11 +66,11 @@
\list 1
\li Select \gui Analyze > \gui {Clang Static Analyzer}.
\li Select \uicontrol Analyze > \uicontrol {Clang Static Analyzer}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png
(\gui Start) button to run the Clang Static Analyzer on the
(\uicontrol Start) button to run the Clang Static Analyzer on the
application.
\endlist
......
......@@ -52,12 +52,12 @@
For more information about analyzing applications for which you do not have
a project, see \l{Running Valgrind Tools on External Applications}.
To stop the currently running analyzer, select \gui {Analyze
To stop the currently running analyzer, select \uicontrol {Analyze
> Stop}.
To select options for the Valgrind tools, select \gui {Tools > Options >
To select options for the Valgrind tools, select \uicontrol {Tools > Options >
Analyzer}. You can override the general settings for each project in the
\gui {Run Settings} for the project.
\uicontrol {Run Settings} for the project.
The following sections describe how to use the Valgrind tools:
......
......@@ -44,9 +44,9 @@
\list 1
\li In the \gui Projects mode, select a debug build configuration.
\li In the \uicontrol Projects mode, select a debug build configuration.
\li Select \gui Analyze > \gui {Valgrind Memory Analyzer}.
\li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button"
......@@ -57,14 +57,14 @@
\li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the
\gui {Analysis} view.
\uicontrol {Analysis} view.
\endlist
While the application is running, Memcheck checks all reads and writes of
memory and intercepts calls that allocate or free memory or create or
delete memory blocks. When you stop Memcheck, it displays the results in
the \gui Analysis view. Click a line to view where a memory leak
the \uicontrol Analysis view. Click a line to view where a memory leak
occurred and a stack trace that shows what caused it.
\image analyzer-issues.png "Analysis view"
......@@ -83,22 +83,22 @@
Stack traces can get quite large and confusing, and therefore, reading them
from the bottom up can help. If the stack trace is not big enough or it is
too big, select \gui {Tools > Options > Analyzer}.
Define the length of the stack trace in the \gui {Backtrace frame count}
too big, select \uicontrol {Tools > Options > Analyzer}.
Define the length of the stack trace in the \uicontrol {Backtrace frame count}
field.
\image qtcreator-valgrind-memcheck-options.png "Memory Analysis options"
Memcheck also reports uses of uninitialised values, most commonly with the
message \gui {Conditional jump or move depends on uninitialised value(s).}
To determine the root cause of these errors, the \gui {Track origins of
message \uicontrol {Conditional jump or move depends on uninitialised value(s).}
To determine the root cause of these errors, the \uicontrol {Track origins of
uninitialized memory} check box is selected by default. You can deselect it
to make Memcheck run faster.
Memcheck searches for memory leaks when the client application finishes. To
view the amount of leaks that occurred, select \gui {Summary Only} in the
\gui {Check for leaks on finish} field. To also view details of each leak,
select \gui Full.
view the amount of leaks that occurred, select \uicontrol {Summary Only} in the
\uicontrol {Check for leaks on finish} field. To also view details of each leak,
select \uicontrol Full.
\section2 Showing Reachable and Indirectly Lost Blocks
......@@ -109,7 +109,7 @@
root node are indirectly lost.
By default, Memcheck does not report reachable and indirectly lost blocks.
To have them reported, select the \gui {Show reachable and indirectly lost
To have them reported, select the \uicontrol {Show reachable and indirectly lost
blocks}.
\section2 Suppressing Errors
......@@ -122,7 +122,7 @@
You can write your own suppression files if parts of your project contain
errors you cannot fix and you do not want to be reminded of them. Click
\gui Add in the \gui {Memory Analysis} dialog to add the suppression files.
\uicontrol Add in the \uicontrol {Memory Analysis} dialog to add the suppression files.
For more information about writing suppression files, see
\l{http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress}
{Suppressing Errors} in the Valgrind documentation.
......@@ -152,9 +152,9 @@
\list 1
\li In the \gui Projects mode, select a release build configuration.
\li In the \uicontrol Projects mode, select a release build configuration.
\li Select \gui Analyze > \gui {Valgrind Function Profiler}.
\li Select \uicontrol Analyze > \uicontrol {Valgrind Function Profiler}.
\li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button"
......@@ -164,7 +164,7 @@
\li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the \gui Profile
button to view the results of the analysis in the \uicontrol Profile
view.
\endlist
......@@ -177,7 +177,7 @@
the runtime behavior of an application.
Double-click a function to view information about the calling functions in
the \gui Callers view and about the called functions in the \gui Callees
the \uicontrol Callers view and about the called functions in the \uicontrol Callees
view.
Since the run-time characteristics of debug and release
......@@ -204,12 +204,12 @@
separately for each project in the \l{Specifying Run Settings}{run settings}
of the project.
To specify settings for Valgrind, select \gui {Tools > Options >
Analyzer}. The \gui {Profiling Options} group contains Callgrind options.
To specify settings for Valgrind, select \uicontrol {Tools > Options >
Analyzer}. The \uicontrol {Profiling Options} group contains Callgrind options.
\image qtcreator-valgrind-callgrind-options.png "Valgrind options"
In the \gui {Result view: Minimum event cost}
In the \uicontrol {Result view: Minimum event cost}
field, limit the amount of results the profiler gives you to increase
profiler performance.
......@@ -219,7 +219,7 @@
\section2 Enabling Full Cache Simulation
By default, only instruction read accesses (Ir) are counted. To fully
simulate the cache, select the \gui {Enable cache simulation} check box.
simulate the cache, select the \uicontrol {Enable cache simulation} check box.
This enables the following additional event counters:
\list
......@@ -235,7 +235,7 @@
\section2 Enabling Branch Prediction Simulation
To enable the following additional event counters, select the
\gui {Enable branch prediction simulation} check box:
\uicontrol {Enable branch prediction simulation} check box:
\list
......@@ -266,9 +266,9 @@
\list 1
\li Select \gui Analyze > \gui {Valgrind Memory Analyzer (External
\li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer (External
Remote Application)} or
\gui {Valgrind Function Profiler (External Remote Application)}.
\uicontrol {Valgrind Function Profiler (External Remote Application)}.
\image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog"
......
This diff is collapsed.
......@@ -128,17 +128,17 @@
\list 1
\li Select \gui Tools > \gui Options > \gui Android to add paths to the
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Android to add paths to the
Android NDK and SDK.
You can use the
\inlineimage qtcreator-options-android-download-button.png
(\gui Download) buttons to go to the sites where you can download
(\uicontrol Download) buttons to go to the sites where you can download
the Android NDK and SDK.
\image qtcreator-options-android1.png "Android options"
\li Select the \gui {Automatically create kits for Android tool chains}
\li Select the \uicontrol {Automatically create kits for Android tool chains}
check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version.
......@@ -146,54 +146,54 @@
\list
\li To use Gradle, select the \gui {Use Gradle instead of Ant}
\li To use Gradle, select the \uicontrol {Use Gradle instead of Ant}
check box.
\li To use Ant, add the path to the Ant executable in the
\gui {Ant executable} field.
\uicontrol {Ant executable} field.
\endlist
\li Select \gui File > \gui {New File or Project} > \gui Application >
\gui {Qt Quick Application} > \gui Choose, and
\li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\uicontrol {Qt Quick Application} > \uicontrol Choose, and
follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}.
\li To specify settings for deploying applications to Android, select
\gui Projects > \gui Run for the \gui Android kit, and then select
\gui Details to view the \gui {Deploy configurations}. For more
\uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select
\uicontrol Details to view the \uicontrol {Deploy configurations}. For more
information about the options you have, see
\l{Deploying Applications to Android Devices}.
\li Enable debugging on your Android device.
Debugging is enabled in different ways on different Android devices.
Look for \gui {USB Debugging} under \gui {Developer Options}. On
some devices \gui {Developer Options} is hidden and becomes visible
when you tap the \gui {Build number} field in \gui Settings >
\gui About several times.
Look for \uicontrol {USB Debugging} under \uicontrol {Developer Options}. On
some devices \uicontrol {Developer Options} is hidden and becomes visible
when you tap the \uicontrol {Build number} field in \uicontrol Settings >
\uicontrol About several times.
\li Connect the Android device to the development PC with a USB cable.
You might be asked to select a device in the
\gui {Select Android Devices} dialog.
\uicontrol {Select Android Devices} dialog.
\endlist
\section1 Selecting Android Devices
When you deploy an application to an Android device with Android
version 4.2 or later, the \gui {Select Android Devices} dialog opens. It
version 4.2 or later, the \uicontrol {Select Android Devices} dialog opens. It
lists the devices that are connected to the development PC. and their
status. You can select devices from the \gui {Compatible Devices} list for
status. You can select devices from the \uicontrol {Compatible Devices} list for
deployment.
If \QC determines that a device is not ready for deployment, it places the
device in the \gui {Incompatible Devices} list, with information about the
device in the \uicontrol {Incompatible Devices} list, with information about the
issue. For example, you might need to authorize the connection on the
device. After you authorize the connection on the device, select
\gui {Refresh Device List}. The device is moved to the
\gui {Compatible Devices} list and you can select it for deployment.
\uicontrol {Refresh Device List}. The device is moved to the
\uicontrol {Compatible Devices} list and you can select it for deployment.
Other reasons for placing a device on the \gui {Incompatible Devices} are
Other reasons for placing a device on the \uicontrol {Incompatible Devices} are
that the Android version on the device is too old or that the tool chain
used for building does not match the Android architecture on the device
(for example, you cannot deploy an ARM build on an x86 device).
......@@ -201,21 +201,21 @@
\image qtcreator-android-select-devices.png "Select Android Devices dialog"
Android Virtual Devices (AVD) are also listed. To create new AVDs, select
\gui {Create Android Virtual Device}.
\uicontrol {Create Android Virtual Device}.
To set a device as the default device for a particular Android architecture,
select the \gui {Always use this device for architecture} check box. The
\gui {Select Android Devices} dialog will not appear until you switch to
select the \uicontrol {Always use this device for architecture} check box. The
\uicontrol {Select Android Devices} dialog will not appear until you switch to
another project or restart \QC.
\section1 Using the Android Emulator
To run your application on the Android Emulator, you must create Android
virtual devices (AVD). Select \gui Tools > \gui Options > \gui Android >
\gui Add. If you run an application without a device connected to the
virtual devices (AVD). Select \uicontrol Tools > \uicontrol Options > \uicontrol Android >
\uicontrol Add. If you run an application without a device connected to the
development PC and without an AVD specified, \QC asks you to add an AVD.
To manage AVDs, select \gui {Start AVD Manager}.
To manage AVDs, select \uicontrol {Start AVD Manager}.
\note The Android Emulator has a bug that prevents it from starting on some
systems. If the Android Emulator does not start, you can try starting it
......@@ -228,7 +228,7 @@
information, see the Android documentation.
In addition, debugging is supported at android-10 API level, or higher. In
the run settings for the project, in the \gui {Android build SDK} field,
the run settings for the project, in the \uicontrol {Android build SDK} field,
select android-10, or higher. For more information about Android API levels,
see \l{http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels}
{What is API Level?}.
......
......@@ -45,13 +45,13 @@
\endlist
To specify settings for application packages, select \gui Projects >
\gui {Build Android APK} > \gui Details.
To specify settings for application packages, select \uicontrol Projects >
\uicontrol {Build Android APK} > \uicontrol Details.
\section1 Creating Distributable APK Packages
To copy Qt libraries and files to the project directory and to bundle them
as part of the APK, select the \gui {Bundle Qt libraries in APK} option.
as part of the APK, select the \uicontrol {Bundle Qt libraries in APK} option.
\note Android 5 devices support only this option.
......@@ -70,7 +70,7 @@
created by \QC.
To use Ministro to install the Qt libraries, select the
\gui {Use Ministro service to install Qt} option.
\uicontrol {Use Ministro service to install Qt} option.
\section1 Deploying Qt Libraries for Debugging
......@@ -84,7 +84,7 @@
turn-around time, and is therefore convenient for testing the application
during development.
Select the \gui {Deploy local Qt libraries to temporary directory} option to
Select the \uicontrol {Deploy local Qt libraries to temporary directory} option to
deploy Qt libraries to the \c{/data/local/tmp/qt} folder on the device and
to run the application against them.
......@@ -92,7 +92,7 @@
Because bundling applications as APK packages is not
trivial, Qt 5 provides a deployment tool called \c androiddeployqt.
When you deploy an application using a \gui {Qt for Android Kit}, \QC uses
When you deploy an application using a \uicontrol {Qt for Android Kit}, \QC uses
the \c androiddeployqt tool to create the necessary files and to bundle them
into an APK:
......@@ -122,15 +122,15 @@
\endlist
The Gradle wrappers and scripts are bundled only if you use Gradle, which is
the default. To use Ant instead, deselect the \gui {Use Gradle} check box.
the default. To use Ant instead, deselect the \uicontrol {Use Gradle} check box.
To view the packages that the \c androiddeployqt tool created, select the
\gui {Open package location after build} check box.
\uicontrol {Open package location after build} check box.
The packages are deployed on the connected Android devices. To switch the
device used as a default device for the selected kit, select
\gui Projects > \gui Run >
\gui {Reset Default Devices}. The setting applies until you restart \QC.
\uicontrol Projects > \uicontrol Run >
\uicontrol {Reset Default Devices}. The setting applies until you restart \QC.
For more information, see \l{Selecting Android Devices}.
For more information about the \c androiddeployqt tool, see
......@@ -139,8 +139,8 @@
\section2 Specifying Settings for Packages
You can specify settings for the \c androiddeployqt tool in \QC and in the
project .pro file. To specify settings in \QC, select \gui Projects >
\gui {Build Android APK} > \gui Details.
project .pro file. To specify settings in \QC, select \uicontrol Projects >
\uicontrol {Build Android APK} > \uicontrol Details.
\image qtcreator-android-deploy-configurations.png "Deploy configurations"
......@@ -150,12 +150,12 @@
\l{Deploying an Application on Android#qmake-variables}{qmake Variables}.
You can view information about what the anddroiddeployqt tool is doing in
the \gui {Compile Output} pane. To view additional information, select the
\gui {Verbose output} check box.
the \uicontrol {Compile Output} pane. To view additional information, select the
\uicontrol {Verbose output} check box.
\section3 Selecting API Level
In the \gui {Android build SDK} field, you can select the API level to use
In the \uicontrol {Android build SDK} field, you can select the API level to use
for building the application. Usually, you should select the newest API
level available.
......@@ -197,45 +197,45 @@
\list 1
\li In the \gui Keystore field, select \gui Create to create a new
keystore that contains one key pair in the \gui {Create Keystore and
\li In the \uicontrol Keystore field, select \uicontrol Create to create a new
keystore that contains one key pair in the \uicontrol {Create Keystore and
a Certificate} dialog:
\image qtcreator-android-certificate.png
\li In the \gui Keystore group, enter a password to protect the
\li In the \uicontrol Keystore group, enter a password to protect the
keystore.
\li In the \gui Certificate group, specify the key size and validity
\li In the \uicontrol Certificate group, specify the key size and validity
period of the certificate. You can specify a separate password to
protect the key pair or use the keystore password.
\li In the \gui {Certificate Distinguished Names} group, enter
\li In the \uicontrol {Certificate Distinguished Names} group, enter
information about yourself and your company or organization that
identifies the issuer and the owner of the key pair.
\li Select \gui Save.
\li Select \uicontrol Save.
\li In the \gui {Keystore File Name} dialog, enter a name for the
\li In the \uicontrol {Keystore File Name} dialog, enter a name for the
keystore and select a location for it.
\li In the \gui Keystore dialog, enter the keystore password to create
\li In the \uicontrol Keystore dialog, enter the keystore password to create
the key pair in the keystore.
\endlist
To sign an Android package by using a key pair, specify settings in the
\gui {Sign package} group:
\uicontrol {Sign package} group:
\list 1
\li In the \gui Keystore field, select \gui Choose to select an existing
\li In the \uicontrol Keystore field, select \uicontrol Choose to select an existing
keystore.
\li In the \gui {Certificate alias} field, select an alias from the list
\li In the \uicontrol {Certificate alias} field, select an alias from the list
of key pairs that the keystore contains.
\li Select the \gui {Sign package} check box to use the alias to
\li Select the \uicontrol {Sign package} check box to use the alias to
sign the Android package.
\endlist
......@@ -244,12 +244,12 @@
\QC automatically detects which Qt libraries the application uses and adds
them as dependencies. If the application needs external libraries, specify
them in the \gui {Additional Libraries} field. The libraries are copied into
them in the \uicontrol {Additional Libraries} field. The libraries are copied into
your application's library folder and loaded on startup.
For example, to enable OpenSSL in your application, add the paths to the
required \c libssl.so and \c libcrypto.so libraries to the
\gui {Additional Libraries} field.
\uicontrol {Additional Libraries} field.
\section3 Editing Manifest Files
......@@ -258,14 +258,14 @@
Android manifest file until you want to publish the package in an
application store. To specify additional settings for APK packages, you can
create an Android manifest file and edit it in \QC. Select
\gui {Create Templates} to create the file and to open it in the
\uicontrol {Create Templates} to create the file and to open it in the
Android Manifest Editor.
\image qtcreator-android-manifest-editor.png "Android Manifest Editor"
\list 1
\li In the \gui {Package name} field, enter a package name for the application.
\li In the \uicontrol {Package name} field, enter a package name for the application.
The application is launched by an automatically generated Java launcher that
is packaged with the application into an Android package (.apk). For more
information, see
......@@ -273,39 +273,39 @@
{Android Application Fundamentals}.
\li You can specify an internal version number for the package in the
\gui {Version code} field. It is used to determine whether one version of
the application is more recent than another. In the \gui {Version name}
\uicontrol {Version code} field. It is used to determine whether one version of
the application is more recent than another. In the \uicontrol {Version name}
field, specify the version number that is shown to users.
\li In the \gui {Minimum required SDK} field, select the minimum API level
\li In the \uicontrol {Minimum required SDK} field, select the minimum API level
required to run the application. The minimum supported API level is
android-9. \QC does not allow you to select an API
level that the Qt version specified for the kit does not support.
\li In the \gui {Target SDK} field, select the targeted API level of the
\li In the \uicontrol {Target SDK} field, select the targeted API level of the
application. This affects the activation of some compatibility features in
the OS. The value used by the \c androiddeployqt tool by default is 14, which
means that the overflow button in the system navigation bar will not be
enabled by default.
\li In the \gui Application group, you can give the application a name and
\li In the \uicontrol Application group, you can give the application a name and
select an icon for it. The three icon fields can contain different versions
of the icon with low, medium, and high DPI values, from left to right.
\li In the \gui Permissions field, you can specify the permissions that your
\li In the \uicontrol Permissions field, you can specify the permissions that your
application needs. Users are asked to grant the permissions when they
install the application. Android OS then grants the application access to
the appropriate data and features.
\li Select the \gui {Include default permissions for Qt modules} and
\gui {Include default features for Qt modules} check boxes to add the
\li Select the \uicontrol {Include default permissions for Qt modules} and
\uicontrol {Include default features for Qt modules} check boxes to add the
permissions needed by Qt libraries.
\li To add permissions, select them in the list, and then select \gui Add.
\li To add permissions, select them in the list, and then select \uicontrol Add.
\endlist
Select the \gui {XML Source} tab to edit the file in XML format.
Select the \uicontrol {XML Source} tab to edit the file in XML format.
\section1 Installing Ministro
......@@ -317,7 +317,7 @@
from the Google Market or from the
\l{http://necessitas.kde.org/necessitas/ministro.php}{Ministro} home page.
Then select \gui Projects > \gui Run > \gui {Install Ministro from APK}.
Then select \uicontrol Projects > \uicontrol Run > \uicontrol {Install Ministro from APK}.
You can use this option also to install any Android package (.apk).
......
......@@ -40,18 +40,18 @@
\list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Device Support} >