feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: use \uicontrol command instead of \gui macro

Browse Source 
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
This commit is contained in:
Leena Miettinen
2014-12-11 15:43:19 +01:00
committed by Leena Miettinen
parent c9696aa6f4
commit e1fbeedcd4
97 changed files with 1955 additions and 1876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/src/analyze/creator-analyze.qdoc
View File

@@ -30,20 +30,20 @@
\title Analyzing Code \title Analyzing Code
You can use the code analysis tools in the \gui Analyze mode. To switch to You can use the code analysis tools in the \uicontrol Analyze mode. To switch to
\gui Analyze mode, select \gui Analyze in the mode selector, or select the \uicontrol Analyze mode, select \uicontrol Analyze in the mode selector, or
\gui {Analyze} menu and then select a tool. When you are in the select the \uicontrol {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 \uicontrol Analyze mode, you can switch between tools by selecting them in the
menu on the toolbar. menu on the toolbar.
\image qtcreator-analyze-menu.png "Analyze mode menu" \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 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. 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 \list

15
doc/src/analyze/creator-clang-static-analyzer.qdoc
View File

@@ -48,14 +48,15 @@
\list 1 \list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Code Analyzer} > \li Select \uicontrol Help > \uicontrol {About Plugins} >
\gui {Clang Static Analyzer} to enable the experimental plugin. \uicontrol {Code Analyzer} > \uicontrol {Clang Static Analyzer} to
enable the experimental plugin.
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Analyzer > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer >
\gui {Clang Static Analyzer} to check that the path to the Clang \uicontrol {Clang Static Analyzer} to check that the path to the Clang
executable is set correctly in the \gui {Clang executable} field. executable is set correctly in the \uicontrol {Clang executable} field.
\image qtcreator-clang-static-analyzer-options.png \image qtcreator-clang-static-analyzer-options.png
@@ -65,11 +66,11 @@
\list 1 \list 1
\li Select \gui Analyze > \gui {Clang Static Analyzer}. \li Select \uicontrol Analyze > \uicontrol {Clang Static Analyzer}.
\li Select the \li Select the
\inlineimage qtcreator-analyze-start-button.png \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. application.
\endlist \endlist

6
doc/src/analyze/creator-valgrind-overview.qdoc
View File

@@ -52,12 +52,12 @@
For more information about analyzing applications for which you do not have For more information about analyzing applications for which you do not have
a project, see \l{Running Valgrind Tools on External Applications}. 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}. > 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 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: The following sections describe how to use the Valgrind tools:

48
doc/src/analyze/creator-valgrind.qdoc
View File

@@ -44,9 +44,9 @@
\list 1 \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 \li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button" \inlineimage qtcreator-analyze-start-button.png "Start button"
@@ -57,14 +57,14 @@
\li Select the \li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button" \inlineimage qtcreator-debug-button-stop.png "Stop button"
button to view the results of the analysis in the button to view the results of the analysis in the
\gui {Analysis} view. \uicontrol {Analysis} view.
\endlist \endlist
While the application is running, Memcheck checks all reads and writes of While the application is running, Memcheck checks all reads and writes of
memory and intercepts calls that allocate or free memory or create or memory and intercepts calls that allocate or free memory or create or
delete memory blocks. When you stop Memcheck, it displays the results in 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. occurred and a stack trace that shows what caused it.
\image analyzer-issues.png "Analysis view" \image analyzer-issues.png "Analysis view"
@@ -83,22 +83,22 @@
Stack traces can get quite large and confusing, and therefore, reading them 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 from the bottom up can help. If the stack trace is not big enough or it is
too big, select \gui {Tools > Options > Analyzer}. too big, select \uicontrol {Tools > Options > Analyzer}.
Define the length of the stack trace in the \gui {Backtrace frame count} Define the length of the stack trace in the \uicontrol {Backtrace frame count}
field. field.
\image qtcreator-valgrind-memcheck-options.png "Memory Analysis options" \image qtcreator-valgrind-memcheck-options.png "Memory Analysis options"
Memcheck also reports uses of uninitialised values, most commonly with the Memcheck also reports uses of uninitialised values, most commonly with the
message \gui {Conditional jump or move depends on uninitialised value(s).} message \uicontrol {Conditional jump or move depends on uninitialised value(s).}
To determine the root cause of these errors, the \gui {Track origins of 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 uninitialized memory} check box is selected by default. You can deselect it
to make Memcheck run faster. to make Memcheck run faster.
Memcheck searches for memory leaks when the client application finishes. To Memcheck searches for memory leaks when the client application finishes. To
view the amount of leaks that occurred, select \gui {Summary Only} in the view the amount of leaks that occurred, select \uicontrol {Summary Only} in the
\gui {Check for leaks on finish} field. To also view details of each leak, \uicontrol {Check for leaks on finish} field. To also view details of each leak,
select \gui Full. select \uicontrol Full.
\section2 Showing Reachable and Indirectly Lost Blocks \section2 Showing Reachable and Indirectly Lost Blocks
@@ -109,7 +109,7 @@
root node are indirectly lost. root node are indirectly lost.
By default, Memcheck does not report reachable and indirectly lost blocks. 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}. blocks}.
\section2 Suppressing Errors \section2 Suppressing Errors
@@ -122,7 +122,7 @@
You can write your own suppression files if parts of your project contain 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 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 For more information about writing suppression files, see
\l{http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress} \l{http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress}
{Suppressing Errors} in the Valgrind documentation. {Suppressing Errors} in the Valgrind documentation.
@@ -152,9 +152,9 @@
\list 1 \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 \li Select the
\inlineimage qtcreator-analyze-start-button.png "Start button" \inlineimage qtcreator-analyze-start-button.png "Start button"
@@ -164,7 +164,7 @@
\li Select the \li Select the
\inlineimage qtcreator-debug-button-stop.png "Stop button" \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. view.
\endlist \endlist
@@ -177,7 +177,7 @@
the runtime behavior of an application. the runtime behavior of an application.
Double-click a function to view information about the calling functions in 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. view.
Since the run-time characteristics of debug and release 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} separately for each project in the \l{Specifying Run Settings}{run settings}
of the project. of the project.
To specify settings for Valgrind, select \gui {Tools > Options > To specify settings for Valgrind, select \uicontrol {Tools > Options >
Analyzer}. The \gui {Profiling Options} group contains Callgrind options. Analyzer}. The \uicontrol {Profiling Options} group contains Callgrind options.
\image qtcreator-valgrind-callgrind-options.png "Valgrind 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 field, limit the amount of results the profiler gives you to increase
profiler performance. profiler performance.
@@ -219,7 +219,7 @@
\section2 Enabling Full Cache Simulation \section2 Enabling Full Cache Simulation
By default, only instruction read accesses (Ir) are counted. To fully 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: This enables the following additional event counters:
\list \list
@@ -235,7 +235,7 @@
\section2 Enabling Branch Prediction Simulation \section2 Enabling Branch Prediction Simulation
To enable the following additional event counters, select the To enable the following additional event counters, select the
\gui {Enable branch prediction simulation} check box: \uicontrol {Enable branch prediction simulation} check box:
\list \list
@@ -266,9 +266,9 @@
\list 1 \list 1
\li Select \gui Analyze > \gui {Valgrind Memory Analyzer (External \li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer (External
Remote Application)} or 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" \image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog"

176
doc/src/analyze/qtquick-profiler.qdoc
View File

@@ -38,63 +38,63 @@
for the project. For more information, see for the project. For more information, see
\l{Setting Up QML Debugging}. \l{Setting Up QML Debugging}.
\li In the \gui Projects mode, select a \l{glossary-buildandrun-kit} \li In the \uicontrol Projects mode, select a \l{glossary-buildandrun-kit}
{kit} with Qt version 4.7.4 or later. {kit} with Qt version 4.7.4 or later.
\note To profile applications on devices, you must install Qt 4.7.4 \note To profile applications on devices, you must install Qt 4.7.4
or later libraries on them. or later libraries on them.
\li Select \gui {Analyze > QML Profiler} to profile the current \li Select \uicontrol {Analyze > QML Profiler} to profile the current
application. application.
\li Select the \li Select the
\inlineimage qtcreator-analyze-start-button.png \inlineimage qtcreator-analyze-start-button.png
(\gui Start) button to start the application from the (\uicontrol Start) button to start the application from the
QML Profiler. QML Profiler.
\note If data collection does not start automatically, select the \note If data collection does not start automatically, select the
\inlineimage qtcreator-analyzer-button.png \inlineimage qtcreator-analyzer-button.png
(\gui {Enable Profiling}) button. (\uicontrol {Enable Profiling}) button.
\endlist \endlist
When you start analyzing an application, the application is launched, and When you start analyzing an application, the application is launched, and
the QML Profiler immediately begins to collect data. This is indicated by the QML Profiler immediately begins to collect data. This is indicated by
the time running in the \gui Elapsed field. the time running in the \uicontrol Elapsed field.
Data is collected until you select the \gui {Enable Profiling} button. Data Data is collected until you select the \uicontrol {Enable Profiling} button. Data
collection collection
takes time, and therefore, there might be a delay takes time, and therefore, there might be a delay
before the data is displayed. before the data is displayed.
Do not use application commands to exit the application, because data is Do not use application commands to exit the application, because data is
sent to the QML Profiler when you select the \gui {Enable Profiling} button. sent to the QML Profiler when you select the \uicontrol {Enable Profiling} button.
The application continues to run for some seconds, after which it is stopped The application continues to run for some seconds, after which it is stopped
automatically. If you exit the application, the data is not sent. automatically. If you exit the application, the data is not sent.
Select the \gui {Disable Profiling} button to disable the automatic Select the \uicontrol {Disable Profiling} button to disable the automatic
start of the data collection when an start of the data collection when an
application is launched. Data collection starts when you select the button application is launched. Data collection starts when you select the button
again. again.
To save all the collected data, right-click any QML Profiler view to open To save all the collected data, right-click any QML Profiler view to open
the context menu, and then select \gui {Save QML Trace}. To view the saved the context menu, and then select \uicontrol {Save QML Trace}. To view the saved
data, select \gui {Load QML Trace}. You can also deliver the saved data to data, select \uicontrol {Load QML Trace}. You can also deliver the saved data to
other developers for examination or load data saved by them. other developers for examination or load data saved by them.
\section1 Attaching to Running Qt Quick Applications \section1 Attaching to Running Qt Quick Applications
To profile Qt Quick applications that are not launched by \QC, select To profile Qt Quick applications that are not launched by \QC, select
\gui {Analyze > QML Profiler (External)}. You must enable QML debugging for \uicontrol {Analyze > QML Profiler (External)}. You must enable QML debugging for
the application in the project build settings. For more information, see the application in the project build settings. For more information, see
\l{Setting Up QML Debugging}. \l{Setting Up QML Debugging}.
In the \gui {QML Profiler} dialog, \gui Port field, specify the port to In the \uicontrol {QML Profiler} dialog, \uicontrol Port field, specify the port to
listen to. listen to.
\section1 Analyzing Collected Data \section1 Analyzing Collected Data
The \gui Timeline view displays graphical representations of QML and The \uicontrol Timeline view displays graphical representations of QML and
JavaScript execution and a condensed view of all recorded events. JavaScript execution and a condensed view of all recorded events.
\image qtcreator-qml-performance-monitor.png "QML Profiler" \image qtcreator-qml-performance-monitor.png "QML Profiler"
@@ -102,36 +102,36 @@
Each row in the timeline (6) describes a type of QML events that were Each row in the timeline (6) describes a type of QML events that were
recorded. Move the cursor on an event on a row to see how long it takes and recorded. Move the cursor on an event on a row to see how long it takes and
where in the source it is being called. To display the information only when where in the source it is being called. To display the information only when
an event is selected, disable the \gui {View Event Information on Mouseover} an event is selected, disable the \uicontrol {View Event Information on Mouseover}
button (5). button (5).
The outline (10) summarizes the period for which data was collected. Drag The outline (10) summarizes the period for which data was collected. Drag
the zoom range (8) or click the outline to move on the outline. You can the zoom range (8) or click the outline to move on the outline. You can
also move between events by selecting the \gui {Jump to Previous Event} (1) also move between events by selecting the \uicontrol {Jump to Previous Event} (1)
and \gui {Jump to Next Event} (2) buttons. and \uicontrol {Jump to Next Event} (2) buttons.
Select the \gui {Show Zoom Slider} button (3) to open a slider that you can Select the \uicontrol {Show Zoom Slider} button (3) to open a slider that you can
use to set the zoom level. You can also drag the zoom handles (9). To reset use to set the zoom level. You can also drag the zoom handles (9). To reset
the default zoom level, right-click the timeline to open the context menu, the default zoom level, right-click the timeline to open the context menu,
and select \gui {Reset Zoom}. and select \uicontrol {Reset Zoom}.
\section2 Selecting Event Ranges \section2 Selecting Event Ranges
You can select an event range (7) to view the frame rate of events and to You can select an event range (7) to view the frame rate of events and to
compare it with the frame rate of similar events. Select the compare it with the frame rate of similar events. Select the
\gui {Select Range} button (4) to activate the selection tool. Then click in \uicontrol {Select Range} button (4) to activate the selection tool. Then click in
the timeline to specify the beginning of the event range. Drag the selection the timeline to specify the beginning of the event range. Drag the selection
handle to define the end of the range. The length of the range indicates the handle to define the end of the range. The length of the range indicates the
frame rate of the event. frame rate of the event.
You can use event ranges also to measure delays between two subsequent You can use event ranges also to measure delays between two subsequent
events. Place a range between the end of the first event and the beginning events. Place a range between the end of the first event and the beginning
of the second event. The \gui Duration field displays the delay between the of the second event. The \uicontrol Duration field displays the delay between the
events in milliseconds. events in milliseconds.
To zoom into an event range, double-click it. To zoom into an event range, double-click it.
To remove an event range, close the \gui Selection dialog. To remove an event range, close the \uicontrol Selection dialog.
\section2 Understanding the Data \section2 Understanding the Data
@@ -158,7 +158,7 @@
\li Commercial Only \li Commercial Only
\row \row
\li \gui {Pixmap Cache} \li \uicontrol {Pixmap Cache}
\li Displays the general amount of pixmap data cached, in pixels. In \li Displays the general amount of pixmap data cached, in pixels. In
addition, displays a separate event for each picture being loaded, addition, displays a separate event for each picture being loaded,
with specifics about its file name and size. with specifics about its file name and size.
@@ -167,7 +167,7 @@
\li \image ok \li \image ok
\row \row
\li \gui {Scene Graph} \li \uicontrol {Scene Graph}
\li Displays the time when scene graph frames are rendered and some \li Displays the time when scene graph frames are rendered and some
additional timing information for the various stages executed to do additional timing information for the various stages executed to do
so. so.
@@ -175,7 +175,7 @@
\li Qt Quick 2 \li Qt Quick 2
\li \image ok \li \image ok
\row \row
\li \gui {Memory Usage} \li \uicontrol {Memory Usage}
\li Displays block allocations of the JavaScript memory manager. \li Displays block allocations of the JavaScript memory manager.
Generally, the memory manager will reserve larger blocks of memory Generally, the memory manager will reserve larger blocks of memory
in one piece and later hand them out to the application in smaller in one piece and later hand them out to the application in smaller
@@ -191,21 +191,21 @@
\li \image ok \li \image ok
\row \row
\li \gui {Input Events} \li \uicontrol {Input Events}
\li Displays mouse and keyboard events. \li Displays mouse and keyboard events.
\li Qt 4.7.4 \li Qt 4.7.4
\li Qt Quick 1 or Qt Quick 2 \li Qt Quick 1 or Qt Quick 2
\li \image ok \li \image ok
\row \row
\li \gui Painting \li \uicontrol Painting
\li Displays the time spent painting the scene for each frame. \li Displays the time spent painting the scene for each frame.
\li Qt 4.7.4 \li Qt 4.7.4
\li Qt Quick 1 \li Qt Quick 1
\li \li
\row \row
\li \gui Animations \li \uicontrol Animations
\li Displays the amount of animations that are active and the frame \li Displays the amount of animations that are active and the frame
rate that they are running at. rate that they are running at.
Information about render thread animations is displayed for Information about render thread animations is displayed for
@@ -216,14 +216,14 @@
\li \li
\row \row
\li \gui Compiling \li \uicontrol Compiling
\li Displays the time spent compiling the QML files. \li Displays the time spent compiling the QML files.
\li Qt 4.7.4 \li Qt 4.7.4
\li Qt Quick 1 or Qt Quick 2 \li Qt Quick 1 or Qt Quick 2
\li \li
\row \row
\li \gui Creating \li \uicontrol Creating
\li Displays the time spent creating the elements in the scene. In Qt \li Displays the time spent creating the elements in the scene. In Qt
Quick 2, creation of elements takes place in two stages. The first Quick 2, creation of elements takes place in two stages. The first
stage is for the creation of the data structures, including child stage is for the creation of the data structures, including child
@@ -238,7 +238,7 @@
\li \li
\row \row
\li \gui Binding \li \uicontrol Binding
\li Displays the time when a binding is evaluated and how long the \li Displays the time when a binding is evaluated and how long the
evaluation takes. evaluation takes.
\li Qt 4.7.4 \li Qt 4.7.4
@@ -246,7 +246,7 @@
\li \li
\row \row
\li \gui {Handling Signal} \li \uicontrol {Handling Signal}
\li Displays the time when a signal is handled and how long the \li Displays the time when a signal is handled and how long the
handling takes. handling takes.
\li Qt 4.7.4 \li Qt 4.7.4
@@ -254,7 +254,7 @@
\li \li
\row \row
\li \gui JavaScript \li \uicontrol JavaScript
\li Displays the time spent executing the actual JavaScript behind \li Displays the time spent executing the actual JavaScript behind
bindings and signal handlers. It lists all the JavaScript functions bindings and signal handlers. It lists all the JavaScript functions
you may be using to evaluate bindings or handle signals. you may be using to evaluate bindings or handle signals.
@@ -270,7 +270,7 @@
understand how the Qt Quick scene graph works. See understand how the Qt Quick scene graph works. See
\l {Qt Quick Scene Graph} and \l {Qt Quick Scene Graph Renderer} for a \l {Qt Quick Scene Graph} and \l {Qt Quick Scene Graph Renderer} for a
detailed description. The following events are reported in the detailed description. The following events are reported in the
\gui {Scene Graph} category. Not all events are generated by all render \uicontrol {Scene Graph} category. Not all events are generated by all render
loops. In the Windows and Basic render loops everything runs in the same loops. In the Windows and Basic render loops everything runs in the same
thread and the distinction between GUI thread and render thread is thread and the distinction between GUI thread and render thread is
meaningless. meaningless.
@@ -288,7 +288,7 @@
\li Description \li Description
\li Caveats \li Caveats
\row \row
\li \gui {Polish} \li \uicontrol {Polish}
\li GUI \li GUI
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li polish \li polish
@@ -297,18 +297,18 @@
\li Versions of Qt prior to Qt 5.4 record no polish times for the basic \li Versions of Qt prior to Qt 5.4 record no polish times for the basic
render loop and incorrect ones for the windows render loop. render loop and incorrect ones for the windows render loop.
\row \row
\li \gui {GUI Thread Wait} \li \uicontrol {GUI Thread Wait}
\li GUI \li GUI
\li Threaded \li Threaded
\li lock \li lock
\li Executing slots connected to the QQuickWindow::afterAnimating() \li Executing slots connected to the QQuickWindow::afterAnimating()
signal and then locking the render thread's mutex before waiting on signal and then locking the render thread's mutex before waiting on
the same mutex at \gui {GUI Thread Sync}. If this starts long the same mutex at \uicontrol {GUI Thread Sync}. If this starts long
before \gui {Render Thread Sync}, there is \e free time in the GUI before \uicontrol {Render Thread Sync}, there is \e free time in the GUI
thread you could be using for running additional QML or JavaScript. thread you could be using for running additional QML or JavaScript.
\li None \li None
\row \row
\li \gui {GUI Thread Sync} \li \uicontrol {GUI Thread Sync}
\li GUI \li GUI
\li Threaded \li Threaded
\li blockedForSync \li blockedForSync
@@ -316,18 +316,18 @@
to synchronize the QML state into the scene graph. to synchronize the QML state into the scene graph.
\li None \li None
\row \row
\li \gui {Animations} \li \uicontrol {Animations}
\li GUI \li GUI
\li Threaded, Windows \li Threaded, Windows
\li animations \li animations
\li Advancing animations in the GUI thread. The basic render loop does \li Advancing animations in the GUI thread. The basic render loop does
not drive animations in sync with the rendering. This is why no not drive animations in sync with the rendering. This is why no
animation events will be shown when using the basic render loop. animation events will be shown when using the basic render loop.
Watch the \gui {Animations} category to see animation timing in Watch the \uicontrol {Animations} category to see animation timing in
this case. this case.
\li None \li None
\row \row
\li \gui {Render Thread Sync} \li \uicontrol {Render Thread Sync}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li Frame rendered ... sync \li Frame rendered ... sync
@@ -335,21 +335,21 @@
QQuickItem::updatePaintNode(). QQuickItem::updatePaintNode().
\li None \li None
\row \row
\li \gui {Render} \li \uicontrol {Render}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li Frame rendered ... render \li Frame rendered ... render
\li Total time spent rendering the frame, including preparing and \li Total time spent rendering the frame, including preparing and
uploading all the necessary data to the GPU. This is the \e gross uploading all the necessary data to the GPU. This is the \e gross
render time. Do not confuse it with the \e net \gui{Render Render} render time. Do not confuse it with the \e net \uicontrol{Render Render}
time below. time below.
\li With versions of Qt prior to Qt 5.5, the gross render time and the \li With versions of Qt prior to Qt 5.5, the gross render time and the
below breakup of render times may be misaligned by some below breakup of render times may be misaligned by some
microseconds due to different, unsynchronized timers being used to microseconds due to different, unsynchronized timers being used to
measure them. For example \gui {Render Preprocess} might seem to measure them. For example \uicontrol {Render Preprocess} might seem to
start before \gui {Render Thread Sync} is finished. start before \uicontrol {Render Thread Sync} is finished.
\row \row
\li \gui {Swap} \li \uicontrol {Swap}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li Frame rendered ... swap \li Frame rendered ... swap
@@ -358,54 +358,54 @@
incorrect for the basic render loop and versions of Qt prior to incorrect for the basic render loop and versions of Qt prior to
Qt 5.4. The QML profiler shows the correct swap times. Qt 5.4. The QML profiler shows the correct swap times.
\row \row
\li \gui {Render Preprocess} \li \uicontrol {Render Preprocess}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li time in renderer ... preprocess \li time in renderer ... preprocess
\li Calling QSGNode::preprocess() on all nodes that need to be \li Calling QSGNode::preprocess() on all nodes that need to be
preprocessed. This is part of the gross \gui {Render} step. preprocessed. This is part of the gross \uicontrol {Render} step.
\li May not be properly aligned with \gui {Render} with versions of Qt \li May not be properly aligned with \uicontrol {Render} with versions of Qt
prior to Qt 5.5. prior to Qt 5.5.
\row \row
\li \gui {Render Update} \li \uicontrol {Render Update}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li time in renderer ... updates \li time in renderer ... updates
\li Iterating and processing all the nodes in the scene graph to update \li Iterating and processing all the nodes in the scene graph to update
their geometry, transformations, opacity, and other state. In the their geometry, transformations, opacity, and other state. In the
\gui {Render Thread Sync} stage, each node is updated separately \uicontrol {Render Thread Sync} stage, each node is updated separately
with state from the GUI thread. In \gui {Render Update}, all the with state from the GUI thread. In \uicontrol {Render Update}, all the
nodes are combined to create the final scene. This is part of the nodes are combined to create the final scene. This is part of the
gross \gui {Render} step. gross \uicontrol {Render} step.
\li May not be properly aligned with \gui {Render} with versions of Qt \li May not be properly aligned with \uicontrol {Render} with versions of Qt
prior to Qt 5.5. prior to Qt 5.5.
\row \row
\li \gui {Render Bind} \li \uicontrol {Render Bind}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li time in renderer ... binding \li time in renderer ... binding
\li Binding the correct framebuffer for OpenGL rendering. This is part \li Binding the correct framebuffer for OpenGL rendering. This is part
of the gross \gui {Render} step. of the gross \uicontrol {Render} step.
\li May not be properly aligned with \gui {Render} with versions of Qt \li May not be properly aligned with \uicontrol {Render} with versions of Qt
prior to Qt 5.5. prior to Qt 5.5.
\row \row
\li \gui {Render Render} \li \uicontrol {Render Render}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li time in renderer ... rendering \li time in renderer ... rendering
\li The actual process of sending all the data to the GPU via OpenGL. \li The actual process of sending all the data to the GPU via OpenGL.
This is part of the gross \gui {Render} step. This is part of the gross \uicontrol {Render} step.
\li May not be properly aligned with \gui {Render} with versions of Qt \li May not be properly aligned with \uicontrol {Render} with versions of Qt
prior to Qt 5.5. prior to Qt 5.5.
\row \row
\li \gui {Material Compile} \li \uicontrol {Material Compile}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li shader compiled \li shader compiled
\li Compiling GLSL shader programs. \li Compiling GLSL shader programs.
\li None \li None
\row \row
\li \gui {Glyph Render} \li \uicontrol {Glyph Render}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li glyphs ... rendering \li glyphs ... rendering
@@ -413,7 +413,7 @@
\li Versions of Qt prior to Qt 5.4 report incorrect times for these \li Versions of Qt prior to Qt 5.4 report incorrect times for these
events. events.
\row \row
\li \gui {Glyph Upload} \li \uicontrol {Glyph Upload}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li glyphs ... upload \li glyphs ... upload
@@ -421,14 +421,14 @@
\li Versions of Qt prior to Qt 5.4 report incorrect times for these \li Versions of Qt prior to Qt 5.4 report incorrect times for these
events. events.
\row \row
\li \gui {Texture Bind} \li \uicontrol {Texture Bind}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture ... bind \li plain texture ... bind
\li Binding a texture in the OpenGL context using glBindTextures. \li Binding a texture in the OpenGL context using glBindTextures.
\li None \li None
\row \row
\li \gui {Texture Convert} \li \uicontrol {Texture Convert}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture ... convert \li plain texture ... convert
@@ -436,28 +436,28 @@
for usage as a texture. for usage as a texture.
\li None \li None
\row \row
\li \gui {Texture Swizzle} \li \uicontrol {Texture Swizzle}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture ... swizzle \li plain texture ... swizzle
\li Swizzling the texture data on the CPU if necessary. \li Swizzling the texture data on the CPU if necessary.
\li None \li None
\row \row
\li \gui {Texture Upload} \li \uicontrol {Texture Upload}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture ... upload / atlastexture uploaded \li plain texture ... upload / atlastexture uploaded
\li Uploading the texture data to the GPU. \li Uploading the texture data to the GPU.
\li None \li None
\row \row
\li \gui {Texture Mipmap} \li \uicontrol {Texture Mipmap}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture ... mipmap \li plain texture ... mipmap
\li Mipmapping a texture on the GPU. \li Mipmapping a texture on the GPU.
\li None \li None
\row \row
\li \gui {Texture Delete} \li \uicontrol {Texture Delete}
\li Render \li Render
\li Threaded, Basic, Windows \li Threaded, Basic, Windows
\li plain texture deleted \li plain texture deleted
@@ -467,51 +467,51 @@
\section1 Viewing Events \section1 Viewing Events
The \gui Events view displays the number of times each binding, create, The \uicontrol Events view displays the number of times each binding, create,
compile, JavaScript, or signal event is triggered and the average time it compile, JavaScript, or signal event is triggered and the average time it
takes. This allows you to examine which events you need to optimize. A high takes. This allows you to examine which events you need to optimize. A high
number of occurrences might indicate that an event is triggered number of occurrences might indicate that an event is triggered
unnecessarily. To view the median, longest, and shortest time for the unnecessarily. To view the median, longest, and shortest time for the
occurrences, select \gui {Extended Event Statistics} in the context menu. occurrences, select \uicontrol {Extended Event Statistics} in the context menu.
Click on an event to move to it in the source code Click on an event to move to it in the source code
in the code editor. in the code editor.
JavaScript events often duplicate bindings or signals, so you can show and JavaScript events often duplicate bindings or signals, so you can show and
hide them by selecting \gui {Show JavaScript Events} in the context menu. hide them by selecting \uicontrol {Show JavaScript Events} in the context
To show and hide QML events (\gui Create, \gui Compile, and \gui Signal), menu. To show and hide QML events (\uicontrol Create, \uicontrol Compile,
select \gui {Show QML Events}. and \uicontrol Signal), select \uicontrol {Show QML Events}.
\image qtcreator-analyzer-bindings.png "Events view" \image qtcreator-analyzer-bindings.png "Events view"
The \gui Callers and \gui Callees panes show dependencies between events. The \uicontrol Callers and \uicontrol Callees panes show dependencies between events.
They allow you to examine the internal functions of the application. They allow you to examine the internal functions of the application.
The \gui Callers pane summarizes the QML events that trigger a binding. The \uicontrol Callers pane summarizes the QML events that trigger a binding.
This tells you what caused a change in a binding. This tells you what caused a change in a binding.
The \gui Callees pane summarizes the QML events that a binding triggers. The \uicontrol Callees pane summarizes the QML events that a binding triggers.
This tells you which QML events are affected if you change a binding. This tells you which QML events are affected if you change a binding.
Click on an event to move to it in the source code in the code editor. Click on an event to move to it in the source code in the code editor.
When you select an event in the \gui Timeline view, information about it is When you select an event in the \uicontrol Timeline view, information about it is
displayed in the \gui Events view. To view an event range in the \gui Events displayed in the \uicontrol Events view. To view an event range in the \uicontrol Events
view, select \gui {Limit Events Pane to Current Range} in the context menu view, select \uicontrol {Limit Events Pane to Current Range} in the context menu
in the \gui Timeline view. in the \uicontrol Timeline view.
To copy the contents of one view or row to the clipboard, select To copy the contents of one view or row to the clipboard, select
\gui {Copy Table} or \gui {Copy Row} in the context menu. \uicontrol {Copy Table} or \uicontrol {Copy Row} in the context menu.
JavaScript events are shown in the \gui Events view only for applications JavaScript events are shown in the \uicontrol Events view only for applications
that use Qt Quick 2 and are compiled with Qt 5.3 or later. For applications that use Qt Quick 2 and are compiled with Qt 5.3 or later. For applications
that use Qt Quick 2 and are built with Qt 5.0 or 5.1, you can view that use Qt Quick 2 and are built with Qt 5.0 or 5.1, you can view
information about JavaScript events in the separate \gui V8 view. information about JavaScript events in the separate \uicontrol V8 view.
\section2 Viewing More Data \section2 Viewing More Data
The QML JavaScript engine optimizes trivial bindings. The QML Profiler The QML JavaScript engine optimizes trivial bindings. The QML Profiler
may not receive all information about optimized bindings, and therefore, may not receive all information about optimized bindings, and therefore,
it may display the text \gui {<bytecode>} and the message it may display the text \uicontrol {<bytecode>} and the message
\gui {Source code not available} in the \gui Callers and \gui {Callees} \uicontrol {Source code not available} in the \uicontrol Callers and \uicontrol {Callees}
panes. panes.
To inspect the optimized bindings, turn off the QML optimizer by setting To inspect the optimized bindings, turn off the QML optimizer by setting
@@ -520,9 +520,9 @@
\list 1 \list 1
\li Select \gui {Projects > Run}. \li Select \uicontrol {Projects > Run}.
\li In \gui {Run Environment}, click \gui Add. \li In \uicontrol {Run Environment}, click \uicontrol Add.
\li Add the QML_DISABLE_OPTIMIZER variable and set its value to 1. \li Add the QML_DISABLE_OPTIMIZER variable and set its value to 1.

54
doc/src/android/androiddev.qdoc
View File

@@ -128,17 +128,17 @@
\list 1 \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. Android NDK and SDK.
You can use the You can use the
\inlineimage qtcreator-options-android-download-button.png \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. the Android NDK and SDK.
\image qtcreator-options-android1.png "Android options" \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 check box to allow \QC to create the kits for you. \QC displays a
warning if it cannot find a suitable Qt version. warning if it cannot find a suitable Qt version.
@@ -146,54 +146,54 @@
\list \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. check box.
\li To use Ant, add the path to the Ant executable in the \li To use Ant, add the path to the Ant executable in the
\gui {Ant executable} field. \uicontrol {Ant executable} field.
\endlist \endlist
\li Select \gui File > \gui {New File or Project} > \gui Application > \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\gui {Qt Quick Application} > \gui Choose, and \uicontrol {Qt Quick Application} > \uicontrol Choose, and
follow the instructions of the wizard. For more information, see follow the instructions of the wizard. For more information, see
\l{Creating Qt Quick Projects}. \l{Creating Qt Quick Projects}.
\li To specify settings for deploying applications to Android, select \li To specify settings for deploying applications to Android, select
\gui Projects > \gui Run for the \gui Android kit, and then select \uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select
\gui Details to view the \gui {Deploy configurations}. For more \uicontrol Details to view the \uicontrol {Deploy configurations}. For more
information about the options you have, see information about the options you have, see
\l{Deploying Applications to Android Devices}. \l{Deploying Applications to Android Devices}.
\li Enable debugging on your Android device. \li Enable debugging on your Android device.
Debugging is enabled in different ways on different Android devices. Debugging is enabled in different ways on different Android devices.
Look for \gui {USB Debugging} under \gui {Developer Options}. On Look for \uicontrol {USB Debugging} under \uicontrol {Developer Options}. On
some devices \gui {Developer Options} is hidden and becomes visible some devices \uicontrol {Developer Options} is hidden and becomes visible
when you tap the \gui {Build number} field in \gui Settings > when you tap the \uicontrol {Build number} field in \uicontrol Settings >
\gui About several times. \uicontrol About several times.
\li Connect the Android device to the development PC with a USB cable. \li Connect the Android device to the development PC with a USB cable.
You might be asked to select a device in the You might be asked to select a device in the
\gui {Select Android Devices} dialog. \uicontrol {Select Android Devices} dialog.
\endlist \endlist
\section1 Selecting Android Devices \section1 Selecting Android Devices
When you deploy an application to an Android device with Android 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 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. deployment.
If \QC determines that a device is not ready for deployment, it places the 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 issue. For example, you might need to authorize the connection on the
device. After you authorize the connection on the device, select device. After you authorize the connection on the device, select
\gui {Refresh Device List}. The device is moved to the \uicontrol {Refresh Device List}. The device is moved to the
\gui {Compatible Devices} list and you can select it for deployment. \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 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 used for building does not match the Android architecture on the device
(for example, you cannot deploy an ARM build on an x86 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" \image qtcreator-android-select-devices.png "Select Android Devices dialog"
Android Virtual Devices (AVD) are also listed. To create new AVDs, select 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, 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 select the \uicontrol {Always use this device for architecture} check box. The
\gui {Select Android Devices} dialog will not appear until you switch to \uicontrol {Select Android Devices} dialog will not appear until you switch to
another project or restart \QC. another project or restart \QC.
\section1 Using the Android Emulator \section1 Using the Android Emulator
To run your application on the Android Emulator, you must create Android To run your application on the Android Emulator, you must create Android
virtual devices (AVD). Select \gui Tools > \gui Options > \gui Android > virtual devices (AVD). Select \uicontrol Tools > \uicontrol Options > \uicontrol Android >
\gui Add. If you run an application without a device connected to the \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. 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 \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 systems. If the Android Emulator does not start, you can try starting it
@@ -228,7 +228,7 @@
information, see the Android documentation. information, see the Android documentation.
In addition, debugging is supported at android-10 API level, or higher. In 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, 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} see \l{http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels}
{What is API Level?}. {What is API Level?}.

84
doc/src/android/deploying-android.qdoc
View File

@@ -45,13 +45,13 @@
\endlist \endlist
To specify settings for application packages, select \gui Projects > To specify settings for application packages, select \uicontrol Projects >
\gui {Build Android APK} > \gui Details. \uicontrol {Build Android APK} > \uicontrol Details.
\section1 Creating Distributable APK Packages \section1 Creating Distributable APK Packages
To copy Qt libraries and files to the project directory and to bundle them 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. \note Android 5 devices support only this option.
@@ -70,7 +70,7 @@
created by \QC. created by \QC.
To use Ministro to install the Qt libraries, select the 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 \section1 Deploying Qt Libraries for Debugging
@@ -84,7 +84,7 @@
turn-around time, and is therefore convenient for testing the application turn-around time, and is therefore convenient for testing the application
during development. 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 deploy Qt libraries to the \c{/data/local/tmp/qt} folder on the device and
to run the application against them. to run the application against them.
@@ -92,7 +92,7 @@
Because bundling applications as APK packages is not Because bundling applications as APK packages is not
trivial, Qt 5 provides a deployment tool called \c androiddeployqt. 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 the \c androiddeployqt tool to create the necessary files and to bundle them
into an APK: into an APK:
@@ -122,15 +122,15 @@
\endlist \endlist
The Gradle wrappers and scripts are bundled only if you use Gradle, which is 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 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 The packages are deployed on the connected Android devices. To switch the
device used as a default device for the selected kit, select device used as a default device for the selected kit, select
\gui Projects > \gui Run > \uicontrol Projects > \uicontrol Run >
\gui {Reset Default Devices}. The setting applies until you restart \QC. \uicontrol {Reset Default Devices}. The setting applies until you restart \QC.
For more information, see \l{Selecting Android Devices}. For more information, see \l{Selecting Android Devices}.
For more information about the \c androiddeployqt tool, see For more information about the \c androiddeployqt tool, see
@@ -139,8 +139,8 @@
\section2 Specifying Settings for Packages \section2 Specifying Settings for Packages
You can specify settings for the \c androiddeployqt tool in \QC and in the 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 > project .pro file. To specify settings in \QC, select \uicontrol Projects >
\gui {Build Android APK} > \gui Details. \uicontrol {Build Android APK} > \uicontrol Details.
\image qtcreator-android-deploy-configurations.png "Deploy configurations" \image qtcreator-android-deploy-configurations.png "Deploy configurations"
@@ -150,12 +150,12 @@
\l{Deploying an Application on Android#qmake-variables}{qmake Variables}. \l{Deploying an Application on Android#qmake-variables}{qmake Variables}.
You can view information about what the anddroiddeployqt tool is doing in You can view information about what the anddroiddeployqt tool is doing in
the \gui {Compile Output} pane. To view additional information, select the the \uicontrol {Compile Output} pane. To view additional information, select the
\gui {Verbose output} check box. \uicontrol {Verbose output} check box.
\section3 Selecting API Level \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 for building the application. Usually, you should select the newest API
level available. level available.
@@ -197,45 +197,45 @@
\list 1 \list 1
\li In the \gui Keystore field, select \gui Create to create a new \li In the \uicontrol Keystore field, select \uicontrol Create to create a new
keystore that contains one key pair in the \gui {Create Keystore and keystore that contains one key pair in the \uicontrol {Create Keystore and
a Certificate} dialog: a Certificate} dialog:
\image qtcreator-android-certificate.png \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. 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 period of the certificate. You can specify a separate password to
protect the key pair or use the keystore password. 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 information about yourself and your company or organization that
identifies the issuer and the owner of the key pair. 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. 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. the key pair in the keystore.
\endlist \endlist
To sign an Android package by using a key pair, specify settings in the To sign an Android package by using a key pair, specify settings in the
\gui {Sign package} group: \uicontrol {Sign package} group:
\list 1 \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. 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. 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. sign the Android package.
\endlist \endlist
@@ -244,12 +244,12 @@
\QC automatically detects which Qt libraries the application uses and adds \QC automatically detects which Qt libraries the application uses and adds
them as dependencies. If the application needs external libraries, specify 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. your application's library folder and loaded on startup.
For example, to enable OpenSSL in your application, add the paths to the For example, to enable OpenSSL in your application, add the paths to the
required \c libssl.so and \c libcrypto.so libraries 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 \section3 Editing Manifest Files
@@ -258,14 +258,14 @@
Android manifest file until you want to publish the package in an Android manifest file until you want to publish the package in an
application store. To specify additional settings for APK packages, you can application store. To specify additional settings for APK packages, you can
create an Android manifest file and edit it in \QC. Select 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. Android Manifest Editor.
\image qtcreator-android-manifest-editor.png "Android Manifest Editor" \image qtcreator-android-manifest-editor.png "Android Manifest Editor"
\list 1 \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 The application is launched by an automatically generated Java launcher that
is packaged with the application into an Android package (.apk). For more is packaged with the application into an Android package (.apk). For more
information, see information, see
@@ -273,39 +273,39 @@
{Android Application Fundamentals}. {Android Application Fundamentals}.
\li You can specify an internal version number for the package in the \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 \uicontrol {Version code} field. It is used to determine whether one version of
the application is more recent than another. In the \gui {Version name} the application is more recent than another. In the \uicontrol {Version name}
field, specify the version number that is shown to users. 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 required to run the application. The minimum supported API level is
android-9. \QC does not allow you to select an API android-9. \QC does not allow you to select an API
level that the Qt version specified for the kit does not support. 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 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 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 means that the overflow button in the system navigation bar will not be
enabled by default. 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 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. 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 application needs. Users are asked to grant the permissions when they
install the application. Android OS then grants the application access to install the application. Android OS then grants the application access to
the appropriate data and features. the appropriate data and features.
\li Select the \gui {Include default permissions for Qt modules} and \li Select the \uicontrol {Include default permissions for Qt modules} and
\gui {Include default features for Qt modules} check boxes to add the \uicontrol {Include default features for Qt modules} check boxes to add the
permissions needed by Qt libraries. 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 \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 \section1 Installing Ministro
@@ -317,7 +317,7 @@
from the Google Market or from the from the Google Market or from the
\l{http://necessitas.kde.org/necessitas/ministro.php}{Ministro} home page. \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). You can use this option also to install any Android package (.apk).

16
doc/src/baremetal/creator-baremetal-dev.qdoc
View File

@@ -40,18 +40,18 @@
\list 1 \list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Device Support} > \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {Device Support} >
\gui {Bare Metal} to enable the Bare Metal Device plugin. \uicontrol {Bare Metal} to enable the Bare Metal Device plugin.
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Devices > \gui Add > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices > \uicontrol Add >
\gui {Bare Metal Device} > \gui {Start Wizard}. \uicontrol {Bare Metal Device} > \uicontrol {Start Wizard}.
\li In the \gui {GDB host} and \gui {GDB port} fields, specify the host \li In the \uicontrol {GDB host} and \uicontrol {GDB port} fields, specify the host
name and port number to access the GDB server or hardware debugger. name and port number to access the GDB server or hardware debugger.
\li In the \gui {GDB commands} fields, specify custom commands for the \li In the \uicontrol {GDB commands} fields, specify custom commands for the
GDB server or hardware debugger. GDB server or hardware debugger.
\li To specify build settings: \li To specify build settings:
@@ -61,7 +61,7 @@
\li Open a project for an application you want to develop for the \li Open a project for an application you want to develop for the
device. device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to \li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add a kit for building and running applications on bare metal add a kit for building and running applications on bare metal
devices. devices.
@@ -69,7 +69,7 @@
\endlist \endlist
\li Select \gui Run to specify run settings. \li Select \uicontrol Run to specify run settings.
Usually, you can use the default settings. Usually, you can use the default settings.

18
doc/src/debugger/creator-debugger-example.qdoc
View File

@@ -31,7 +31,7 @@
\title Debugging a C++ Example Application \title Debugging a C++ Example Application
This section uses the \l{Creating a Qt Widget Based Application}{TextFinder} This section uses the \l{Creating a Qt Widget Based Application}{TextFinder}
example to illustrate how to debug Qt C++ applications in the \gui Debug example to illustrate how to debug Qt C++ applications in the \uicontrol Debug
mode. mode.
TextFinder reads a text file into QString and then displays it with TextFinder reads a text file into QString and then displays it with
@@ -45,19 +45,19 @@
\image qtcreator-setting-breakpoint1.png \image qtcreator-setting-breakpoint1.png
\li Select \gui{Debug > Start Debugging > Start Debugging} or press \li Select \uicontrol{Debug > Start Debugging > Start Debugging} or press
\key{F5}. \key{F5}.
\li To view the breakpoint, click the \gui{Breakpoints} tab. \li To view the breakpoint, click the \uicontrol{Breakpoints} tab.
\image qtcreator-setting-breakpoint2.png \image qtcreator-setting-breakpoint2.png
\li To remove a breakpoint, right-click it and select \li To remove a breakpoint, right-click it and select
\gui{Delete Breakpoint}. \uicontrol{Delete Breakpoint}.
\li To view the base classes and data members of the TextFinder class, \li To view the base classes and data members of the TextFinder class,
go to the \gui{Locals and Expressions} view. go to the \uicontrol{Locals and Expressions} view.
\image qtcreator-watcher.png \image qtcreator-watcher.png
@@ -101,12 +101,12 @@
work correctly due to a logic error. To locate this logic error, step work correctly due to a logic error. To locate this logic error, step
through the code using the following buttons: through the code using the following buttons:
\inlineimage qtcreator-debug-button-stop.png \inlineimage qtcreator-debug-button-stop.png
(\gui Stop), (\uicontrol Stop),
\inlineimage qtcreator-debug-button-step-over.png \inlineimage qtcreator-debug-button-step-over.png
(\gui {Step Over}), (\uicontrol {Step Over}),
\inlineimage qtcreator-debug-button-step-into.png \inlineimage qtcreator-debug-button-step-into.png
(\gui {Step Into}), and (\uicontrol {Step Into}), and
\inlineimage qtcreator-debug-button-step-out.png \inlineimage qtcreator-debug-button-step-out.png
(\gui {Step Out}). (\uicontrol {Step Out}).
*/ */

73
doc/src/debugger/creator-debugger-setup.qdoc
View File

@@ -33,8 +33,8 @@
The main debugger settings are associated with the The main debugger settings are associated with the
\l{glossary-buildandrun-kit}{kit} you build and run your project with. To specify the \l{glossary-buildandrun-kit}{kit} you build and run your project with. To specify the
debugger and compiler to use for each kit, select \gui Tools > debugger and compiler to use for each kit, select \uicontrol Tools >
\gui Options > \gui {Build and Run} > \gui Kits. \uicontrol Options > \uicontrol {Build and Run} > \uicontrol Kits.
You need to set up the debugger only if the automatic setup You need to set up the debugger only if the automatic setup
fails, because the native debugger is missing (as is usually the fails, because the native debugger is missing (as is usually the
@@ -45,11 +45,12 @@
\note If you need to change the debugger to use for an automatically \note If you need to change the debugger to use for an automatically
detected \l{glossary-buildandrun-kit}{kit}, detected \l{glossary-buildandrun-kit}{kit},
you can \gui{Clone} the kit and change the parameters in you can \uicontrol{Clone} the kit and change the parameters in
the clone. Make sure to select the cloned kit for your project. the clone. Make sure to select the cloned kit for your project.
If the debugger you want to use is not automatically detected, select If the debugger you want to use is not automatically detected, select
\gui Tools > \gui Options > \gui {Build & Run} > \gui Debuggers > \gui Add \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\uicontrol Debuggers > \uicontrol Add
to add it. to add it.
\note To use the debugging tools for Windows, you must install them \note To use the debugging tools for Windows, you must install them
@@ -218,8 +219,8 @@
If you use a qmake based project in \QC, you can set a If you use a qmake based project in \QC, you can set a
flag in your \l{glossary-run-config}{run configuration}, in flag in your \l{glossary-run-config}{run configuration}, in
\gui Projects mode. In the run configuration, select \uicontrol Projects mode. In the run configuration, select
\gui{Use debug version of frameworks}. \uicontrol{Use debug version of frameworks}.
For more detailed information about debugging on OS X, For more detailed information about debugging on OS X,
see: \l{http://developer.apple.com/library/mac/#technotes/tn2124/_index.html#//apple_ref/doc/uid/DTS10003391} see: \l{http://developer.apple.com/library/mac/#technotes/tn2124/_index.html#//apple_ref/doc/uid/DTS10003391}
@@ -238,13 +239,13 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui General > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger
\gui Add. > \uicontrol General > \uicontrol Add.
\li In the \gui {Source path} field, specify the source path in the \li In the \uicontrol {Source path} field, specify the source path in the
debug information of the executable as reported by the debugger. debug information of the executable as reported by the debugger.
\li In the \gui {Target path} field, specify the actual location of the \li In the \uicontrol {Target path} field, specify the actual location of the
source tree on the local machine. source tree on the local machine.
\endlist \endlist
@@ -257,13 +258,14 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui CDB. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
\uicontrol CDB.
\li In the \gui {Symbol paths} field, open the \gui Insert menu \li In the \uicontrol {Symbol paths} field, open the \uicontrol Insert
and select \gui{Symbol Server}. menu and select \uicontrol{Symbol Server}.
\li Select a directory where you want to store the cached information \li Select a directory where you want to store the cached information
and click \gui OK. and click \uicontrol OK.
Use a subfolder in a temporary directory, such as Use a subfolder in a temporary directory, such as
\c {C:\temp\symbolcache}. \c {C:\temp\symbolcache}.
@@ -283,32 +285,32 @@
\list 1 \list 1
\li To create a key for signing FSF GDB, select \gui {Keychain Access > \li To create a key for signing FSF GDB, select \uicontrol {Keychain Access >
Certificate Assistant > Create a Certificate}: Certificate Assistant > Create a Certificate}:
\list 1 \list 1
\li In the \gui {Name} field, input \gui {fsfgdb} to replace \li In the \uicontrol {Name} field, input \uicontrol {fsfgdb} to replace
the existing content. the existing content.
\li In the \gui {Certificate Type} field, select \li In the \uicontrol {Certificate Type} field, select
\gui {Code Signing}. \uicontrol {Code Signing}.
\li Select the \gui {Let me override defaults} check box. \li Select the \uicontrol {Let me override defaults} check box.
\li Select \gui Continue, and follow the instructions of the \li Select \uicontrol Continue, and follow the instructions of the
wizard (use the default settings), until the \gui {Specify a wizard (use the default settings), until the \uicontrol {Specify a
Location For The Certificate} dialog opens. Location For The Certificate} dialog opens.
\li In the \gui Keychain field, select \gui System. \li In the \uicontrol Keychain field, select \uicontrol System.
\li Select \gui {Keychain Access > System}, and locate the \li Select \uicontrol {Keychain Access > System}, and locate the
certificate. certificate.
\li Double click the certificate to view certificate information. \li Double click the certificate to view certificate information.
\li In the \gui Trust section, select \gui {Always Trust} in the \li In the \uicontrol Trust section, select \uicontrol {Always Trust} in the
\gui {When using this certificate} field, and then close \uicontrol {When using this certificate} field, and then close
the dialog. the dialog.
\endlist \endlist
@@ -319,14 +321,14 @@
codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb
\endcode \endcode
\li In \QC, select \gui {Qt Creator > Preferences > Build & Run > \li In \QC, select \uicontrol {Qt Creator > Preferences > Build & Run >
Kits} > \gui Add to create a kit that uses FSF GDB. Kits} > \uicontrol Add to create a kit that uses FSF GDB.
\li In the \gui Debugger field, specify the path to FSF GDB \li In the \uicontrol Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for (\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME). \c $HOME).
\li To use the debugger, add the kit in the \gui {Build Settings} \li To use the debugger, add the kit in the \uicontrol {Build Settings}
of the project. of the project.
\endlist \endlist
@@ -338,17 +340,18 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits. \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits.
\li Select an automatically created kit in the list, and then select \li Select an automatically created kit in the list, and then select
\gui Clone to create a copy of the kit. \uicontrol Clone to create a copy of the kit.
\li In the \gui Debugger field, select an LLDB Engine. If an LLDB Engine \li In the \uicontrol Debugger field, select an LLDB Engine. If an LLDB Engine
is not listed, select \gui Manage to add it in \gui Tools > is not listed, select \uicontrol Manage to add it in \uicontrol Tools >
\gui Options > \gui {Build & Run} > \gui Debuggers. For more \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Debuggers. For more
information, see \l {Adding Debuggers}. information, see \l {Adding Debuggers}.
\li To use the debugger, add the kit in the \gui {Build Settings} \li To use the debugger, add the kit in the \uicontrol {Build Settings}
of the project. of the project.
\endlist \endlist

228
doc/src/debugger/creator-debugger.qdoc
View File

@@ -49,12 +49,12 @@
To start an application from an open project under the control To start an application from an open project under the control
of a debugger, press the Debug button in the lower left corner of a debugger, press the Debug button in the lower left corner
of the main view, or press \key{F5}. Other, less common start of the main view, or press \key{F5}. Other, less common start
options are available in the \gui{Debug} > \gui{Start Debugging} options are available in the \uicontrol{Debug} > \uicontrol{Start Debugging}
menu. menu.
\li \l{Interacting with the Debugger} \li \l{Interacting with the Debugger}
You can use the tool views in the \gui Debug mode to inspect the You can use the tool views in the \uicontrol Debug mode to inspect the
state of your application while debugging. state of your application while debugging.
\li \l{Using Debugging Helpers} \li \l{Using Debugging Helpers}
@@ -99,13 +99,13 @@
\title Launching the Debugger \title Launching the Debugger
To start an application from an open project under the control To start an application from an open project under the control
of a debugger, press the \gui Debug button in the lower left corner of a debugger, press the \uicontrol Debug button in the lower left corner
of the main view, or press \key{F5}. of the main view, or press \key{F5}.
\QC checks whether the compiled program is up-to-date, and rebuilds \QC checks whether the compiled program is up-to-date, and rebuilds
and deploys it if the \gui{Always build project before deploying it} and and deploys it if the \uicontrol{Always build project before deploying it} and
\gui{Always deploy before running} options are selected in the \uicontrol{Always deploy before running} options are selected in the
\gui{Build and Run} options. \uicontrol{Build and Run} options.
The debugger then takes over and starts the program with suitable The debugger then takes over and starts the program with suitable
parameters. parameters.
@@ -122,7 +122,7 @@
Some of the modes are only available for a particular operating system or Some of the modes are only available for a particular operating system or
platform. platform.
In general, the \key{F5} and the \gui{Debug} button are set up in a way In general, the \key{F5} and the \uicontrol{Debug} button are set up in a way
to start the operating mode that is commonly used in a given context. to start the operating mode that is commonly used in a given context.
So if the current project is set up as a C++ application using So if the current project is set up as a C++ application using
the MinGW toolchain targeting desktop Windows, the GDB engine will the MinGW toolchain targeting desktop Windows, the GDB engine will
@@ -132,8 +132,8 @@
being handled by GDB and GDB server remote debugging. being handled by GDB and GDB server remote debugging.
Change the run configuration Change the run configuration
parameters (such as \gui{Run in Terminal}) in the run settings of the parameters (such as \uicontrol{Run in Terminal}) in the run settings of the
project, or select options from the \gui{Debug} > \gui{Start Debugging} project, or select options from the \uicontrol{Debug} > \uicontrol{Start Debugging}
menu to select other modes of operation. menu to select other modes of operation.
The debugger can run in the following modes: The debugger can run in the following modes:
@@ -163,11 +163,11 @@
all projects using a desktop Qt version and plain C++ projects. all projects using a desktop Qt version and plain C++ projects.
If you need a console window to operate your application, for example because If you need a console window to operate your application, for example because
it accepts console input from the user, go to \gui {Projects > Run it accepts console input from the user, go to \uicontrol {Projects > Run
Settings} and select the \gui {Run in terminal} check box. Settings} and select the \uicontrol {Run in terminal} check box.
To launch the debugger in Start Internal mode, click the To launch the debugger in Start Internal mode, click the
\gui {Start Debugging} button for the active project. \uicontrol {Start Debugging} button for the active project.
You can specify breakpoints before or after launching the debugger. You can specify breakpoints before or after launching the debugger.
For more information, see \l{Setting Breakpoints}. For more information, see \l{Setting Breakpoints}.
@@ -175,14 +175,14 @@
\section2 Launching in Start External Mode \section2 Launching in Start External Mode
To run any executable already present on your local or a remote machine To run any executable already present on your local or a remote machine
without using a project, select \gui{Debug > Start Debugging without using a project, select \uicontrol{Debug > Start Debugging
> Start and Debug External Application}. > Start and Debug External Application}.
\section2 Launching in Attach Mode \section2 Launching in Attach Mode
To attach the debugger to an application already running on your To attach the debugger to an application already running on your
local or a remote machine, select local or a remote machine, select
\gui {Debug > Start Debugging > Attach to Running Application}, \uicontrol {Debug > Start Debugging > Attach to Running Application},
and then select a process by its name or process ID to attach to. and then select a process by its name or process ID to attach to.
While this mode does not strictly require a project to be opened in \QC, While this mode does not strictly require a project to be opened in \QC,
@@ -206,7 +206,7 @@
ulimit -c unlimited ulimit -c unlimited
\endcode \endcode
To launch the debugger in the core mode, select \gui{Debug > Start To launch the debugger in the core mode, select \uicontrol{Debug > Start
Debugging > Load Core File}. Debugging > Load Core File}.
Also in this mode, using a properly configured project containing Also in this mode, using a properly configured project containing
@@ -220,11 +220,11 @@
The \QC installation program asks you whether you want to The \QC installation program asks you whether you want to
register \QC as a post-mortem debugger. To change the setting, select register \QC as a post-mortem debugger. To change the setting, select
\gui Tools > \gui Options > \gui Debugger > \gui General > \gui {Use Qt \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
Creator for post-mortem debugging}. \uicontrol General > \uicontrol {Use QtCreator for post-mortem debugging}.
You can launch the debugger in the post-mortem mode if an application You can launch the debugger in the post-mortem mode if an application
crashes on Windows. Click the \gui {Debug in \QC} button in the error crashes on Windows. Click the \uicontrol {Debug in \QC} button in the error
message that is displayed by the Windows operating system. message that is displayed by the Windows operating system.
@@ -244,8 +244,8 @@
the user of \QC. To start debugging on a remote target with the the user of \QC. To start debugging on a remote target with the
necessary helper processes running, select the corresponding necessary helper processes running, select the corresponding
\l{glossary-buildandrun-kit}{kit} in \l{glossary-buildandrun-kit}{kit} in
\gui{Projects > Build & Run}, and then select a function to start remote \uicontrol{Projects > Build & Run}, and then select a function to start remote
debugging in the \gui{Debug > Start Debugging} menu. debugging in the \uicontrol{Debug > Start Debugging} menu.
Special use cases, such as attaching to a running process on the Special use cases, such as attaching to a running process on the
target, might still require manual setup. target, might still require manual setup.
@@ -273,13 +273,13 @@
\list 1 \list 1
\li Select \gui {Debug > Start Debugging > Attach to Remote \li Select \uicontrol {Debug > Start Debugging > Attach to Remote
Debug Server}. Debug Server}.
\li In the \gui {Host and port} field, enter the name of the remote \li In the \uicontrol {Host and port} field, enter the name of the remote
machine and the port number to use. machine and the port number to use.
\li Select \gui{OK} to start debugging. \li Select \uicontrol{OK} to start debugging.
\endlist \endlist
@@ -322,10 +322,10 @@
\endcode \endcode
\li On the local machine running \QC, select \li On the local machine running \QC, select
\gui {Debug > Start Debugging > Attach to Remote CDB Session} \uicontrol {Debug > Start Debugging > Attach to Remote CDB Session}
\li In the \gui Connection field enter the connection parameters. \li In the \uicontrol Connection field enter the connection parameters.
For example, for TCP/IP: For example, for TCP/IP:
\code \code
@@ -345,7 +345,7 @@
ssl:proto=Protocol,{certuser=Cert|machuser=Cert},clicon=Server,port=Socket[,password=Password] ssl:proto=Protocol,{certuser=Cert|machuser=Cert},clicon=Server,port=Socket[,password=Password]
\endcode \endcode
\li Click \gui{OK} to start debugging. \li Click \uicontrol{OK} to start debugging.
\endlist \endlist
*/ */
@@ -359,7 +359,7 @@
\title Interacting with the Debugger \title Interacting with the Debugger
You can use the \QC \gui Debug mode to inspect the state of your application You can use the \QC \uicontrol Debug mode to inspect the state of your application
while debugging. You can interact with the debugger in several ways, while debugging. You can interact with the debugger in several ways,
including the following: including the following:
@@ -402,11 +402,11 @@
\section1 Using the Debugger \section1 Using the Debugger
In \gui Debug mode, you can use several views to interact with the In \uicontrol Debug mode, you can use several views to interact with the
program you are debugging. The availability of views depends on whether program you are debugging. The availability of views depends on whether
you are debugging C++ or QML. Frequently used views are shown by you are debugging C++ or QML. Frequently used views are shown by
default and rarely used ones are hidden. To change the default settings, default and rarely used ones are hidden. To change the default settings,
select \gui {Window > Views}, and then select views to display or hide. select \uicontrol {Window > Views}, and then select views to display or hide.
Alternatively, you can enable or disable views from the context menu Alternatively, you can enable or disable views from the context menu
of the title bar of any visible debugger view. of the title bar of any visible debugger view.
@@ -414,12 +414,12 @@
You can drag and drop the views in \QD to new positions on the screen. You can drag and drop the views in \QD to new positions on the screen.
The size and position of views are saved for future sessions. Select The size and position of views are saved for future sessions. Select
\gui {Window > Views > Reset to Default Layout} to reset the views to \uicontrol {Window > Views > Reset to Default Layout} to reset the views to
their original sizes and positions. their original sizes and positions.
Once the program starts running under the control of the debugger, it Once the program starts running under the control of the debugger, it
behaves and performs as usual. You can interrupt a running C++ program by behaves and performs as usual. You can interrupt a running C++ program by
selecting \gui{Debug} > \gui {Interrupt}. The program is automatically selecting \uicontrol{Debug} > \uicontrol {Interrupt}. The program is automatically
interrupted when a breakpoint is hit. interrupted when a breakpoint is hit.
Once the program stops, \QC: Once the program stops, \QC:
@@ -431,14 +431,14 @@
\li Retrieves the contents of local variables. \li Retrieves the contents of local variables.
\li Examines \gui Expressions. \li Examines \uicontrol Expressions.
\li Updates the \gui Registers, \gui Modules, and \gui Disassembler \li Updates the \uicontrol Registers, \uicontrol Modules, and \uicontrol Disassembler
views if you are debugging the C++ based applications. views if you are debugging the C++ based applications.
\endlist \endlist
You can use the \gui Debug mode views to examine the data in more detail. You can use the \uicontrol Debug mode views to examine the data in more detail.
You can use the following keyboard shortcuts: You can use the following keyboard shortcuts:
@@ -475,8 +475,8 @@
to you. You can then examine the state of the interrupted program, or to you. You can then examine the state of the interrupted program, or
continue execution either line-by-line or continuously. continue execution either line-by-line or continuously.
\QC shows breakpoints in the \gui{Breakpoints} view which is enabled \QC shows breakpoints in the \uicontrol{Breakpoints} view which is enabled
by default. The \gui{Breakpoints} view is also accessible when the debugger by default. The \uicontrol{Breakpoints} view is also accessible when the debugger
and the program being debugged is not running. and the program being debugged is not running.
\image qtcreator-debug-breakpoints.png "Breakpoints view" \image qtcreator-debug-breakpoints.png "Breakpoints view"
@@ -523,28 +523,28 @@
(\key F8 for OS X) at a particular line you want the (\key F8 for OS X) at a particular line you want the
program to stop. program to stop.
\li In the \gui Breakpoints view, double-click in the empty \li In the \uicontrol Breakpoints view, double-click in the empty
part of the view. part of the view.
\li In the \gui Breakpoints view, select \gui {Add Breakpoint} \li In the \uicontrol Breakpoints view, select \uicontrol {Add Breakpoint}
in the context menu. in the context menu.
\endlist \endlist
\li In the \gui {Breakpoint type} field, select the location in the \li In the \uicontrol {Breakpoint type} field, select the location in the
program code where you want the program to stop. The other options program code where you want the program to stop. The other options
to specify depend on the selected location. to specify depend on the selected location.
\image qtcreator-add-breakpoint.png "Add Breakpoints" dialog \image qtcreator-add-breakpoint.png "Add Breakpoints" dialog
\li In the \gui Condition field, set the condition to be evaluated \li In the \uicontrol Condition field, set the condition to be evaluated
before stopping at the breakpoint if the condition evaluates as before stopping at the breakpoint if the condition evaluates as
true. true.
\li In the \gui Ignore field, specify the number of times that the \li In the \uicontrol Ignore field, specify the number of times that the
breakpoint is ignored before the program stops. breakpoint is ignored before the program stops.
\li In the \gui Commands field, specify the commands to execute when \li In the \uicontrol Commands field, specify the commands to execute when
the program stops; one command on a line. GDB executes the commands the program stops; one command on a line. GDB executes the commands
in the order in which they are specified. in the order in which they are specified.
@@ -566,11 +566,11 @@
\li Click the breakpoint marker in the text editor. \li Click the breakpoint marker in the text editor.
\li Select the breakpoint in the \gui Breakpoints view and press \li Select the breakpoint in the \uicontrol Breakpoints view and press
\key{Delete}. \key{Delete}.
\li Select \gui{Delete Breakpoint} in the context menu in the \li Select \uicontrol{Delete Breakpoint} in the context menu in the
\gui Breakpoints view. \uicontrol Breakpoints view.
\endlist \endlist
@@ -583,20 +583,20 @@
\list 1 \list 1
\li Right-click in the \gui Breakpoints view to open the context menu, \li Right-click in the \uicontrol Breakpoints view to open the context menu,
and select \gui {Add Breakpoint}. and select \uicontrol {Add Breakpoint}.
\li In the \gui {Breakpoint type} field, select \gui {Break on data \li In the \uicontrol {Breakpoint type} field, select \uicontrol {Break on data
access at fixed address}. access at fixed address}.
\li In the \gui Address field, specify the address of the memory block. \li In the \uicontrol Address field, specify the address of the memory block.
\li Select \gui OK. \li Select \uicontrol OK.
\endlist \endlist
If the address is displayed in the \gui {Locals and Expressions} view, you If the address is displayed in the \uicontrol {Locals and Expressions} view, you
can select \gui {Add Data Breakpoint at Object's Address} in the context can select \uicontrol {Add Data Breakpoint at Object's Address} in the context
menu to set the data breakpoint. menu to set the data breakpoint.
\section1 Viewing Call Stack Trace \section1 Viewing Call Stack Trace
@@ -606,22 +606,22 @@
trace. This stack trace is built up from call stack frames, each trace. This stack trace is built up from call stack frames, each
representing a particular function. For each function, \QC tries representing a particular function. For each function, \QC tries
to retrieve the file name and line number of the corresponding source to retrieve the file name and line number of the corresponding source
file. This data is shown in the \gui Stack view. file. This data is shown in the \uicontrol Stack view.
\image qtcreator-debug-stack.png \image qtcreator-debug-stack.png
Since the call stack leading to the current position may originate or go Since the call stack leading to the current position may originate or go
through code for which no debug information is available, not all stack through code for which no debug information is available, not all stack
frames have corresponding source locations. Stack frames without frames have corresponding source locations. Stack frames without
corresponding source locations are grayed out in the \gui{Stack} view. corresponding source locations are grayed out in the \uicontrol{Stack} view.
If you click a frame with a known source location, the text editor If you click a frame with a known source location, the text editor
jumps to the corresponding location and updates the \gui{Locals and Expressions} jumps to the corresponding location and updates the \uicontrol{Locals and Expressions}
view, making it seem like the program was interrupted before entering the view, making it seem like the program was interrupted before entering the
function. function.
To find out which QML file is causing a Qt Quick 2 application to crash, To find out which QML file is causing a Qt Quick 2 application to crash,
select \gui {Load QML Stack} in the context menu in the \gui{Stack} view. select \uicontrol {Load QML Stack} in the context menu in the \uicontrol{Stack} view.
The debugger tries to retrieve the JavaScript stack from the stopped The debugger tries to retrieve the JavaScript stack from the stopped
executable and prepends the frames to the C++ frames, should it find any. executable and prepends the frames to the C++ frames, should it find any.
You can click a frame in the QML stack to open the QML file in the editor. You can click a frame in the QML stack to open the QML file in the editor.
@@ -629,26 +629,26 @@
\section1 Locals and Expressions \section1 Locals and Expressions
The Locals and Expressions view consists of three parts: the The Locals and Expressions view consists of three parts: the
\gui{Locals} pane at the top, the \gui{Return Value} pane in the middle, \uicontrol{Locals} pane at the top, the \uicontrol{Return Value} pane in the middle,
and the \gui{Expressions} pane at the bottom. The \gui{Return Value} and the \uicontrol{Expressions} pane at the bottom. The \uicontrol{Return Value}
and \gui{Expression} panes are only visible if they are not empty. and \uicontrol{Expression} panes are only visible if they are not empty.
\image qtcreator-locals-expressions.png "Locals and Expressions view" \image qtcreator-locals-expressions.png "Locals and Expressions view"
Whenever a program stops under the control of the debugger, it retrieves Whenever a program stops under the control of the debugger, it retrieves
information about the topmost stack frame and displays it in the information about the topmost stack frame and displays it in the
\gui{Locals and Expressions} view. The \gui{Locals} pane shows \uicontrol{Locals and Expressions} view. The \uicontrol{Locals} pane shows
information about parameters of the function in that information about parameters of the function in that
frame as well as the local variables. If the last operation in frame as well as the local variables. If the last operation in
the debugger was returning from a function after pressing the debugger was returning from a function after pressing
\key{Shift+F11}, the \gui{Return Value} pane displays the value \key{Shift+F11}, the \uicontrol{Return Value} pane displays the value
returned by the function. returned by the function.
To compute values of arithmetic expressions or function To compute values of arithmetic expressions or function
calls, use expression evaluators in the \gui{Expressions} pane. calls, use expression evaluators in the \uicontrol{Expressions} pane.
To insert a new expression evaluator, either double-click on an To insert a new expression evaluator, either double-click on an
empty part of the \gui{Locals and Expressions} view, or select empty part of the \uicontrol{Locals and Expressions} view, or select
\gui{Add New Expression Evaluator} from the context menu, or \uicontrol{Add New Expression Evaluator} from the context menu, or
drag and drop an expression from the code editor. drag and drop an expression from the code editor.
\note Expression evaluators are powerful, but slow down debugger \note Expression evaluators are powerful, but slow down debugger
@@ -686,7 +686,7 @@
\li GDB and LLDB, and therefore \QC's debugger, work for optimized \li GDB and LLDB, and therefore \QC's debugger, work for optimized
builds on Linux and OS X. Optimization can lead to builds on Linux and OS X. Optimization can lead to
re-ordering of instructions or removal of some local variables, re-ordering of instructions or removal of some local variables,
causing the \gui{Locals and Expressions} view to show unexpected causing the \uicontrol{Locals and Expressions} view to show unexpected
data. data.
\row \row
\li The debug information provided by GCC does not include enough \li The debug information provided by GCC does not include enough
@@ -694,12 +694,12 @@
Therefore, \QC can not tell whether the contents of a Therefore, \QC can not tell whether the contents of a
local variable contains "real data", or "initial noise". If a local variable contains "real data", or "initial noise". If a
QObject appears uninitialized, its value is reported as QObject appears uninitialized, its value is reported as
\gui {not in scope}. Not all uninitialized objects, however, can be \uicontrol {not in scope}. Not all uninitialized objects, however, can be
recognized as such. recognized as such.
\endtable \endtable
The \gui{Locals and Expressions} view also provides access to the most The \uicontrol{Locals and Expressions} view also provides access to the most
powerful feature of the debugger: comprehensive display of data belonging powerful feature of the debugger: comprehensive display of data belonging
to Qt's basic objects. to Qt's basic objects.
For example, in case of QObject, instead of displaying a pointer to some For example, in case of QObject, instead of displaying a pointer to some
@@ -710,7 +710,7 @@
Also, the debugger displays access data for QFileInfo and provides Also, the debugger displays access data for QFileInfo and provides
access to the "real" contents of QVariant. access to the "real" contents of QVariant.
Right-click in the \gui{Locals and Expressions} view to open a context Right-click in the \uicontrol{Locals and Expressions} view to open a context
menu that provides additional options for viewing data. The available menu that provides additional options for viewing data. The available
options depend on the type of the current items, and are provided by the options depend on the type of the current items, and are provided by the
\l{Using Debugging Helpers}{Debugging Helpers}. Typically, string-like data, \l{Using Debugging Helpers}{Debugging Helpers}. Typically, string-like data,
@@ -719,16 +719,16 @@
as \c{QMap}, \c{QHash}, and \c{std::map}, offer a compact option using the as \c{QMap}, \c{QHash}, and \c{std::map}, offer a compact option using the
\c{name} column for keys, resulting in a concise display of containers with \c{name} column for keys, resulting in a concise display of containers with
short keys, such as numbers or short strings. For example, to expand all the short keys, such as numbers or short strings. For example, to expand all the
values of QMap, select \gui {Change Local Display Format} > \gui Compact. values of QMap, select \uicontrol {Change Local Display Format} > \uicontrol Compact.
You can use the \gui{Locals and Expressions} view to change the contents of You can use the \uicontrol{Locals and Expressions} view to change the contents of
variables of simple data types, for example, \c int, \c float, QString variables of simple data types, for example, \c int, \c float, QString
and \c std::string when the and \c std::string when the
program is interrupted. To do so, click the \gui Value column, modify program is interrupted. To do so, click the \uicontrol Value column, modify
the value with the inplace editor, and press \key Enter (or \key Return). the value with the inplace editor, and press \key Enter (or \key Return).
To change the complete contents of QVector or \c std::vector values, To change the complete contents of QVector or \c std::vector values,
type all values separated by commas into the \gui Value column of type all values separated by commas into the \uicontrol Value column of
the main entry. the main entry.
You can enable tooltips in the main editor displaying this information. You can enable tooltips in the main editor displaying this information.
@@ -740,16 +740,16 @@
In some cases, it is convenient to directly interact with the command In some cases, it is convenient to directly interact with the command
line of the native debugger. In \QC, you can use the left line of the native debugger. In \QC, you can use the left
pane of the \gui {Debugger Log} view for that purpose. When you press pane of the \uicontrol {Debugger Log} view for that purpose. When you press
\key {Ctrl+Enter}, the contents of the line under the text cursor \key {Ctrl+Enter}, the contents of the line under the text cursor
are sent directly to the native debugger. Alternatively, you are sent directly to the native debugger. Alternatively, you
can use the line edit at the bottom of the view. Output is displayed in the can use the line edit at the bottom of the view. Output is displayed in the
right pane of the \gui {Debugger Log} view. right pane of the \uicontrol {Debugger Log} view.
\note Usually, you do not need this feature, because \QC provides \note Usually, you do not need this feature, because \QC provides
you with better ways to handle the task. For example, instead of using the you with better ways to handle the task. For example, instead of using the
GDB \c print command from the command line, you can evaluate an expression GDB \c print command from the command line, you can evaluate an expression
in the \gui{Locals and Expressions} view. in the \uicontrol{Locals and Expressions} view.
\section1 Debugging C++ Based Applications \section1 Debugging C++ Based Applications
@@ -783,19 +783,19 @@
In OS X, external libraries are usually built into so-called Frameworks, In OS X, external libraries are usually built into so-called Frameworks,
which may contain both release and debug versions of the library. When you run which may contain both release and debug versions of the library. When you run
applications on the OS X desktop, the release version of Frameworks is used applications on the OS X desktop, the release version of Frameworks is used
by default. To step into Frameworks, select the \gui {Use debug versions of by default. To step into Frameworks, select the \uicontrol {Use debug versions of
Frameworks} option in the project run settings. Frameworks} option in the project run settings.
\section2 Viewing Threads \section2 Viewing Threads
If a multi-threaded program is interrupted, the \gui Threads view or the If a multi-threaded program is interrupted, the \uicontrol Threads view or the
combobox named \gui Threads in the debugger status bar can be used to combobox named \uicontrol Threads in the debugger status bar can be used to
switch from one thread to another. The \gui Stack view adjusts itself switch from one thread to another. The \uicontrol Stack view adjusts itself
accordingly. accordingly.
\section2 Viewing Modules \section2 Viewing Modules
The \gui{Modules} view displays information that the debugger plugin has The \uicontrol{Modules} view displays information that the debugger plugin has
about modules included in the application that is being debugged. A module about modules included in the application that is being debugged. A module
is a dynamic link library (.dll) in Windows, a shared object (.so) in is a dynamic link library (.dll) in Windows, a shared object (.so) in
Linux, and a dynamic shared library (.dylib) in OS X. Linux, and a dynamic shared library (.dylib) in OS X.
@@ -821,11 +821,11 @@
\endlist \endlist
By default, the \gui{Modules} view is hidden. By default, the \uicontrol{Modules} view is hidden.
\section2 Viewing Source Files \section2 Viewing Source Files
The \gui{Source Files} view lists all the source files included in the project. The \uicontrol{Source Files} view lists all the source files included in the project.
If you cannot step into an instruction, you can check whether the source file is If you cannot step into an instruction, you can check whether the source file is
actually part of the project, or whether it was compiled actually part of the project, or whether it was compiled
elsewhere. The view shows the path to each file in the file system. elsewhere. The view shows the path to each file in the file system.
@@ -833,28 +833,28 @@
Right-click the view to open a context menu that contains menu items for Right-click the view to open a context menu that contains menu items for
reloading data and opening files. reloading data and opening files.
By default, the \gui{Source Files} view is hidden. By default, the \uicontrol{Source Files} view is hidden.
\section2 Viewing Disassembled Code and Register State \section2 Viewing Disassembled Code and Register State
The \gui{Disassembler} view displays disassembled code for the current The \uicontrol{Disassembler} view displays disassembled code for the current
function. The \gui{Registers} view displays the current state of the CPU's function. The \uicontrol{Registers} view displays the current state of the CPU's
registers. registers.
The \gui{Disassembler} view and the \gui{Registers} view are both useful The \uicontrol{Disassembler} view and the \uicontrol{Registers} view are both useful
for low-level commands for checking single instructions, such as \gui{Step Into} for low-level commands for checking single instructions, such as \uicontrol{Step Into}
and \gui{Step Over}. By default, both \gui{Disassembler} and and \uicontrol{Step Over}. By default, both \uicontrol{Disassembler} and
\gui{Registers} view are hidden. \uicontrol{Registers} view are hidden.
\section2 Creating Snapshots \section2 Creating Snapshots
A snapshot contains the complete state of the debugged program A snapshot contains the complete state of the debugged program
at a time, including the full memory contents. at a time, including the full memory contents.
To create snapshots of a debugged program, select \gui {Create Snapshot} in To create snapshots of a debugged program, select \uicontrol {Create Snapshot} in
the context menu in the \gui Snapshots view. the context menu in the \uicontrol Snapshots view.
Double-click on entries in the \gui Snapshots view to switch between Double-click on entries in the \uicontrol Snapshots view to switch between
snapshots. The debugger views are updated to reflect the snapshots. The debugger views are updated to reflect the
state of the program at time of taking the snapshot. state of the program at time of taking the snapshot.
@@ -870,17 +870,17 @@
\title Using Debugging Helpers \title Using Debugging Helpers
Structured data, such as objects of \c class, \c struct, or \c union Structured data, such as objects of \c class, \c struct, or \c union
types, is displayed in the \gui{Locals and Expressions} view as part types, is displayed in the \uicontrol{Locals and Expressions} view as part
of a tree. of a tree.
To access sub-structures of the objects, expand the tree nodes. To access sub-structures of the objects, expand the tree nodes.
The sub-structures are presented in their in-memory order, unless The sub-structures are presented in their in-memory order, unless
the \gui{Sort Members of Classes and Structs Alphabetically} option the \uicontrol{Sort Members of Classes and Structs Alphabetically} option
from the context menu is selected. from the context menu is selected.
Similarly, pointers are displayed as a tree item with a single child Similarly, pointers are displayed as a tree item with a single child
item representing the target of the pointer. In case the item representing the target of the pointer. In case the
context menu item context menu item
\gui{Dereference Pointers Automatically} is selected, the pointer \uicontrol{Dereference Pointers Automatically} is selected, the pointer
and the target are combined into a single entry, showing the name and the target are combined into a single entry, showing the name
and the type of the pointer and the value of the target. and the type of the pointer and the value of the target.
@@ -897,9 +897,9 @@
scripts for use with the GDB and LLDB backends. scripts for use with the GDB and LLDB backends.
Debugging helpers are always automatically used. To force a plain Debugging helpers are always automatically used. To force a plain
C-like display of structures, select \gui Tools > \gui Options > C-like display of structures, select \uicontrol Tools > \uicontrol Options >
\gui Debugger > \gui {Locals & Expressions}, and then deselect the \uicontrol Debugger > \uicontrol {Locals & Expressions}, and then deselect the
\gui{Use Debugging Helper} check box. For GDB \uicontrol{Use Debugging Helper} check box. For GDB
and LLDB this will still use the Python scripts, but generate and LLDB this will still use the Python scripts, but generate
more basic output. To force plain display for a single object more basic output. To force plain display for a single object
or for all objects of a given type, select the corresponding or for all objects of a given type, select the corresponding
@@ -912,7 +912,7 @@
\section1 Extending GDB and LLDB Debugging Helpers \section1 Extending GDB and LLDB Debugging Helpers
When using either GDB or LLDB as the debugging backend, \QC uses Python When using either GDB or LLDB as the debugging backend, \QC uses Python
scripts to display information in the \gui {Locals and Expressions} view. scripts to display information in the \uicontrol {Locals and Expressions} view.
You can easily extend these scripts to cover your own types, You can easily extend these scripts to cover your own types,
using the same code for both the GDB and the LLDB backend. using the same code for both the GDB and the LLDB backend.
@@ -922,8 +922,8 @@
To extend the shipped Python based debugging helpers for custom To extend the shipped Python based debugging helpers for custom
types, add debugging helper implementations to the GDB startup file types, add debugging helper implementations to the GDB startup file
\c{~/.gdbinit}, or specify them directly in the \gui{Additional \c{~/.gdbinit}, or specify them directly in the \uicontrol{Additional
Startup Commands} in \gui {Tools > Options > Debugger > GDB}. Startup Commands} in \uicontrol {Tools > Options > Debugger > GDB}.
The implementation of a debugging helper typically The implementation of a debugging helper typically
consists of a single Python function, which needs to be named consists of a single Python function, which needs to be named
@@ -951,7 +951,7 @@
The \c{qdump__*} function has to feed the Dumper object with certain The \c{qdump__*} function has to feed the Dumper object with certain
information which is used to build up the object and its children's information which is used to build up the object and its children's
display in the \gui{Locals and Expressions} view. display in the \uicontrol{Locals and Expressions} view.
Example: Example:
@@ -972,7 +972,7 @@
\section2 Dumper Class \section2 Dumper Class
For each line in the \gui{Locals and Expressions} view, a string like the For each line in the \uicontrol{Locals and Expressions} view, a string like the
following needs to be created and channeled to the debugger plugin. following needs to be created and channeled to the debugger plugin.
\code \code
{iname='some internal name', # optional {iname='some internal name', # optional
@@ -998,7 +998,7 @@
present, is it generated by concatenating the parent object's iname, present, is it generated by concatenating the parent object's iname,
a dot, and a sequential number. a dot, and a sequential number.
The value of the \c name field is displayed in the \gui{Name} column The value of the \c name field is displayed in the \uicontrol{Name} column
of the view. If it is not specified, a simple number in brackets of the view. If it is not specified, a simple number in brackets
is used instead. is used instead.
@@ -1208,8 +1208,8 @@
You might have created a release build that does not contain debug You might have created a release build that does not contain debug
information. A GNU Compiler Collection (GCC) debug build has the \c {-g} information. A GNU Compiler Collection (GCC) debug build has the \c {-g}
option on the compiler command line. Check that this option is present in option on the compiler command line. Check that this option is present in
the \gui {Compile Output} pane. If it is not, adjust your build settings the \uicontrol {Compile Output} pane. If it is not, adjust your build settings
in the \gui {Projects} mode. in the \uicontrol {Projects} mode.
\section1 Debugger Does Not Work \section1 Debugger Does Not Work
@@ -1222,8 +1222,8 @@
\li Make sure the debugger is set up properly. For more information, \li Make sure the debugger is set up properly. For more information,
see \l{Setting Up Debugger}. see \l{Setting Up Debugger}.
\li In the \gui Debug mode, select \gui {Window > Views > Debugger \li In the \uicontrol Debug mode, select \uicontrol {Window > Views > Debugger
Log} to open the \gui {Debugger Log} view. Browse the contents of Log} to open the \uicontrol {Debugger Log} view. Browse the contents of
the pane on the right hand side to find out what went wrong. the pane on the right hand side to find out what went wrong.
Always attach the contents of the pane to debugger-related Always attach the contents of the pane to debugger-related
questions to the \QC mailing list (qt-creator@trolltech.com) questions to the \QC mailing list (qt-creator@trolltech.com)
@@ -1236,18 +1236,18 @@
\section1 Pointer Variable Members Are Not Displayed Directly \section1 Pointer Variable Members Are Not Displayed Directly
When you use the \gui {Locals and Expressions} view to inspect a pointer When you use the \uicontrol {Locals and Expressions} view to inspect a pointer
variable and expand the variable tree item, another tree item level variable and expand the variable tree item, another tree item level
is displayed. To directly display the members of the pointer variable, is displayed. To directly display the members of the pointer variable,
select \gui {Dereference Pointers Automatically} in the context menu in the select \uicontrol {Dereference Pointers Automatically} in the context menu in the
\gui {Locals and Expressions} view. \uicontrol {Locals and Expressions} view.
\section1 Structure Members Are Not Sorted According to Structure Layout \section1 Structure Members Are Not Sorted According to Structure Layout
By default, structure members are displayed in alphabetic order. By default, structure members are displayed in alphabetic order.
To inspect the real layout in memory, deselect \gui {Sort Members of To inspect the real layout in memory, deselect \uicontrol {Sort Members of
Classes and Structs Alphabetically} in the context menu in the Classes and Structs Alphabetically} in the context menu in the
\gui {Locals and Expressions} view. \uicontrol {Locals and Expressions} view.
\section1 Built-in Debugger Is Slow During Startup and Runtime \section1 Built-in Debugger Is Slow During Startup and Runtime
@@ -1262,7 +1262,7 @@
GDB uses \c ptrace to attach to running processes. Some Linux distributions GDB uses \c ptrace to attach to running processes. Some Linux distributions
do not allow this, which stops all attempts to either directly attach to an do not allow this, which stops all attempts to either directly attach to an
existing process or use the \gui {Run in terminal} option in \QC. existing process or use the \uicontrol {Run in terminal} option in \QC.
The reasons for this are described in The reasons for this are described in
\l{http://wiki.ubuntu.com/SecurityTeam/Roadmap/KernelHardening#ptrace%20Protection} \l{http://wiki.ubuntu.com/SecurityTeam/Roadmap/KernelHardening#ptrace%20Protection}

32
doc/src/debugger/qtquick-debugger-example.qdoc
View File

@@ -33,7 +33,7 @@
This section uses the This section uses the
\l{QML Advanced Tutorial}{Same Game} \l{QML Advanced Tutorial}{Same Game}
example application to illustrate how to debug Qt Quick applications in the example application to illustrate how to debug Qt Quick applications in the
\gui Debug mode. \uicontrol Debug mode.
For more information about all the options you have, see For more information about all the options you have, see
\l{Debugging Qt Quick Projects}. \l{Debugging Qt Quick Projects}.
@@ -53,10 +53,10 @@
The red circle indicates that a breakpoint is now set on that line The red circle indicates that a breakpoint is now set on that line
number. number.
\li Select \gui {Debug > Start Debugging > Start Debugging} or press \li Select \uicontrol {Debug > Start Debugging > Start Debugging} or press
\key{F5}. \key{F5}.
\li Once the Same Game application starts, click the \gui {New Game} \li Once the Same Game application starts, click the \uicontrol {New Game}
button to start a new game. button to start a new game.
\li When the debugger hits the breakpoint, it interrupts the \li When the debugger hits the breakpoint, it interrupts the
@@ -67,24 +67,24 @@
\li Click the \li Click the
\inlineimage qtcreator-debug-button-step-into.png \inlineimage qtcreator-debug-button-step-into.png
(\gui {Step Into}) button on the toolbar or press \key F11 to step (\uicontrol {Step Into}) button on the toolbar or press \key F11 to step
into the code in the stack. The samegame.js file opens in the code into the code in the stack. The samegame.js file opens in the code
editor at the function that starts a new game. editor at the function that starts a new game.
\image qtquick-example-stack.png \image qtquick-example-stack.png
\li Examine the local variables in the \gui {Locals and Expressions} \li Examine the local variables in the \uicontrol {Locals and Expressions}
view. Step through the code to see how the information changes in view. Step through the code to see how the information changes in
the view. the view.
\li Add a breakpoint at the end of the \c {startNewGame()} function, and \li Add a breakpoint at the end of the \c {startNewGame()} function, and
click \inlineimage qtcreator-debugging-continue.png click \inlineimage qtcreator-debugging-continue.png
(\gui Continue) to hit the breakpoint. (\uicontrol Continue) to hit the breakpoint.
\image qtquick-example-setting-breakpoint3.png \image qtquick-example-setting-breakpoint3.png
\li To execute JavaScript commands in the current context, open the \li To execute JavaScript commands in the current context, open the
\gui {QML/JS Console} output pane. \uicontrol {QML/JS Console} output pane.
\li To change the score to 1000, enter \c{gameCanvas.score = 1000} \li To change the score to 1000, enter \c{gameCanvas.score = 1000}
in the console. in the console.
@@ -92,27 +92,27 @@
\image qtquick-example-script-console.png \image qtquick-example-script-console.png
\li To remove a breakpoint, right-click it and select \li To remove a breakpoint, right-click it and select
\gui {Delete Breakpoint}. \uicontrol {Delete Breakpoint}.
\li Select the \gui {Locals and Expressions} tab to explore the object \li Select the \uicontrol {Locals and Expressions} tab to explore the object
structure at runtime: structure at runtime:
\image qtquick-example-qml-inspector.png \image qtquick-example-qml-inspector.png
\li Click \li Click
\inlineimage qml-inspector-app-on-top.png \inlineimage qml-inspector-app-on-top.png
(\gui {Show Application on Top}) to keep the application visible (\uicontrol {Show Application on Top}) to keep the application visible
while you interact with the debugger. while you interact with the debugger.
\li Click \li Click
\inlineimage qml-inspector-select-button.png \inlineimage qml-inspector-select-button.png
(\gui Select) to activate selection mode and then click the (\uicontrol Select) to activate selection mode and then click the
\gui {Quit} button to move into the \gui ButtonLabel component \uicontrol {Quit} button to move into the \uicontrol ButtonLabel component
in the \gui {QML/JS Console} and the code editor. in the \uicontrol {QML/JS Console} and the code editor.
\li In the \gui {Locals and Expressions} view, double-click the value of \li In the \uicontrol {Locals and Expressions} view, double-click the value of
the \c text property to change it temporarily from \gui {Quit} to the \c text property to change it temporarily from \uicontrol {Quit} to
\gui {End Game}. \uicontrol {End Game}.
\image qtquick-example-property-values.png \image qtquick-example-property-values.png

61
doc/src/debugger/qtquick-debugging.qdoc
View File

@@ -41,20 +41,20 @@
\l{Creating Qt Quick Projects}{type of the project}: Qt Quick UI or Qt Quick \l{Creating Qt Quick Projects}{type of the project}: Qt Quick UI or Qt Quick
Application, and the Qt version used. Application, and the Qt version used.
To debug Qt Quick UI projects, select the \gui {Enable QML} check box in the To debug Qt Quick UI projects, select the \uicontrol {Enable QML} check box in the
\gui {Debugger Settings} in \gui Projects mode \gui {Run Settings}. \uicontrol {Debugger Settings} in \uicontrol Projects mode \uicontrol {Run Settings}.
To debug Qt Quick Applications: To debug Qt Quick Applications:
\list 1 \list 1
\li Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7, \li Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7,
select \gui Projects, and then select the select \uicontrol Projects, and then select the
\gui {Enable QML debugging} check box in the \gui qmake section \uicontrol {Enable QML debugging} check box in the \uicontrol qmake section
in \gui {Build Steps}. in \uicontrol {Build Steps}.
You might have to compile the library first, by selecting the You might have to compile the library first, by selecting the
\gui Compile link. \uicontrol Compile link.
\image qml-link-debugging-library.png "Build Steps" \image qml-link-debugging-library.png "Build Steps"
@@ -64,11 +64,11 @@
functions. Therefore, you must make sure that the port is properly functions. Therefore, you must make sure that the port is properly
protected by a firewall. protected by a firewall.
\li In the \gui {Run Settings}, \gui {Debugger Settings} section, select \li In the \uicontrol {Run Settings}, \uicontrol {Debugger Settings} section, select
the \gui {Enable QML} check box to enable the \uicontrol {Enable QML} check box to enable
QML debugging. QML debugging.
\li Select \gui {Build > Rebuild Project} to clean and rebuild the \li Select \uicontrol {Build > Rebuild Project} to clean and rebuild the
project. project.
\li To debug applications on devices, check that Qt 4.7.4, or later, \li To debug applications on devices, check that Qt 4.7.4, or later,
@@ -81,15 +81,15 @@
\section1 Mixed C++/QML Debugging \section1 Mixed C++/QML Debugging
To debug both the C++ and QML parts of your application at the same time, To debug both the C++ and QML parts of your application at the same time,
select the \gui {Enable C++} and \gui {Enable QML} checkboxes for both select the \uicontrol {Enable C++} and \uicontrol {Enable QML} checkboxes for both
languages in the \gui {Debugger Settings} section in the project languages in the \uicontrol {Debugger Settings} section in the project
\gui{Run Settings}. \uicontrol{Run Settings}.
\image qtquick-debugging-settings.png \image qtquick-debugging-settings.png
\section1 Starting QML Debugging \section1 Starting QML Debugging
To start the application, choose \gui {Debug > Start Debugging > To start the application, choose \uicontrol {Debug > Start Debugging >
Start Debugging} or press \key F5. Once the application starts running, it Start Debugging} or press \key F5. Once the application starts running, it
behaves and performs as usual. You can then perform the following tasks: behaves and performs as usual. You can then perform the following tasks:
@@ -132,7 +132,7 @@
the application from running until the debug client connects to the the application from running until the debug client connects to the
server. This enables debugging from the start. server. This enables debugging from the start.
\li Select \gui {Debug > Start Debugging > Attach to QML Port}. \li Select \uicontrol {Debug > Start Debugging > Attach to QML Port}.
Choose the kit configured for the device where the application to Choose the kit configured for the device where the application to
be debugged is running. The port number to use is displayed in the be debugged is running. The port number to use is displayed in the
@@ -142,7 +142,7 @@
\section1 Debugging JavaScript Functions \section1 Debugging JavaScript Functions
You can use the \QC \gui Debug mode to inspect the state of your You can use the \QC \uicontrol Debug mode to inspect the state of your
application while debugging. You can interact with the debugger by: application while debugging. You can interact with the debugger by:
\list \list
@@ -158,8 +158,9 @@
\section1 Executing JavaScript Expressions \section1 Executing JavaScript Expressions
When the application is interrupted by a breakpoint, you can use the When the application is interrupted by a breakpoint, you can use the
\gui {QML/JS Console} to execute JavaScript expressions in the current \uicontrol {QML/JS Console} to execute JavaScript expressions in the current
context. To open it, choose \gui Window > \gui {Output Panes} > \gui {QML/JS Console}. context. To open it, choose \uicontrol Window > \uicontrol {Output Panes}
> \uicontrol {QML/JS Console}.
\image qml-script-console.png "QML/JS Console" \image qml-script-console.png "QML/JS Console"
@@ -174,26 +175,26 @@
debugger can update the properties in the running application when you save debugger can update the properties in the running application when you save
the file. This is enabled by default. To disable it, click the the file. This is enabled by default. To disable it, click the
\inlineimage qml-observer-bar-reload.png "Apply Changes on Save button" \inlineimage qml-observer-bar-reload.png "Apply Changes on Save button"
(\gui {Apply Changes on Save}) button on the toolbar. (\uicontrol {Apply Changes on Save}) button on the toolbar.
\endomit \endomit
When you change property values in the \gui {QML/JS Console} or in the When you change property values in the \uicontrol {QML/JS Console} or in the
\gui {Locals and Expressions} view, they are immediately updated in the running \uicontrol {Locals and Expressions} view, they are immediately updated in the running
application, but not in the source code. application, but not in the source code.
\section1 Inspecting Items \section1 Inspecting Items
While the application is running, you can use the While the application is running, you can use the
\gui {Locals and Expressions} view to explore the QML item structure. \uicontrol {Locals and Expressions} view to explore the QML item structure.
\image qml-observer-view.png "QML item tree" \image qml-observer-view.png "QML item tree"
To keep the application visible while you interact with the debugger, click To keep the application visible while you interact with the debugger, click
\inlineimage qml-inspector-app-on-top.png \inlineimage qml-inspector-app-on-top.png
(\gui {Show Application on Top}). (\uicontrol {Show Application on Top}).
You can view a QML item in \gui {Locals and Expressions} in the following You can view a QML item in \uicontrol {Locals and Expressions} in the following
ways: ways:
\list \list
@@ -204,7 +205,7 @@
\li Click \li Click
\inlineimage qml-inspector-select-button.png \inlineimage qml-inspector-select-button.png
(\gui Select) to activate selection mode and then click an item (\uicontrol Select) to activate selection mode and then click an item
in the running application. in the running application.
\endlist \endlist
@@ -218,9 +219,9 @@
When you debug complex applications, you can jump to the position in code When you debug complex applications, you can jump to the position in code
where an item is defined or you can zoom into the user interface. where an item is defined or you can zoom into the user interface.
When the \gui Select tool is enabled, you can click items in the running When the \uicontrol Select tool is enabled, you can click items in the running
application to jump to their definitions in the code. The properties of the application to jump to their definitions in the code. The properties of the
selected item are displayed in the \gui {Locals and Expressions} view. selected item are displayed in the \uicontrol {Locals and Expressions} view.
You can also view the item hierarchy in the running application: You can also view the item hierarchy in the running application:
@@ -237,14 +238,14 @@
\endlist \endlist
To switch to the zoom mode, click the \gui Zoom button. Click in the To switch to the zoom mode, click the \uicontrol Zoom button. Click in the
running application to zoom in. Right-click to open a context menu that running application to zoom in. Right-click to open a context menu that
contains zoom controls. contains zoom controls.
To switch out of the selection or zoom mode, deselect the \gui Select or To switch out of the selection or zoom mode, deselect the \uicontrol Select or
\gui Zoom button. \uicontrol Zoom button.
To move the application running in \QQV to the front, select the To move the application running in \QQV to the front, select the
\gui {Show Application on Top} button. \uicontrol {Show Application on Top} button.
*/ */

34
doc/src/editors/creator-beautifier.qdoc
View File

@@ -64,39 +64,39 @@
You might have to build the tools from sources for some platforms. You might have to build the tools from sources for some platforms.
\li Select \gui Help > \gui {About Plugins} > \gui {C++} > \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} >
\gui Beautifier to enable the plugin. \uicontrol Beautifier to enable the plugin.
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui Beautifier to specify \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Beautifier to specify
settings for the tool you want to use. settings for the tool you want to use.
\image beautifier_options.png \image beautifier_options.png
\li In the \gui {Artistic Style command}, \gui {Clang Format command}, \li In the \uicontrol {Artistic Style command}, \uicontrol {Clang Format command},
or \gui {Uncrustify command} field, specify the path to the tool or \uicontrol {Uncrustify command} field, specify the path to the tool
executable. executable.
\li In the \gui Options group, select the configuration file that \li In the \uicontrol Options group, select the configuration file that
defines the style to use in the source files. If you select several defines the style to use in the source files. If you select several
options, they are applied from top down. options, they are applied from top down.
\list \list
\li Select the \gui {Use file defined in project files} option \li Select the \uicontrol {Use file defined in project files} option
to use the configuration file defined in the qmake to use the configuration file defined in the qmake
DISTFILES variable as the configuration file for the DISTFILES variable as the configuration file for the
selected tool. selected tool.
\li Select the \gui {Use $HOME} option to use the specified file \li Select the \uicontrol {Use $HOME} option to use the specified file
in the user's home directory as the configuration file for in the user's home directory as the configuration file for
the selected tool. the selected tool.
\li Select the \gui {Use customized style} option, and then \li Select the \uicontrol {Use customized style} option, and then
\gui Add to define your own style. \uicontrol Add to define your own style.
Define code formatting in the \gui {Edit Configuration} Define code formatting in the \uicontrol {Edit Configuration}
dialog. It provides syntax highlighting, auto-completion, dialog. It provides syntax highlighting, auto-completion,
and context-sensitive help. For these features, you must and context-sensitive help. For these features, you must
have the tool installed. have the tool installed.
@@ -105,8 +105,8 @@
\endlist \endlist
\li Select \gui Tools > \gui Beautifier > \gui {Artistic Style}, \li Select \uicontrol Tools > \uicontrol Beautifier > \uicontrol {Artistic Style},
\gui ClangFormat, or \gui Uncrustify > \gui {Format Current File} \uicontrol ClangFormat, or \uicontrol Uncrustify > \uicontrol {Format Current File}
to format the currently open file. to format the currently open file.
You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the
@@ -114,9 +114,9 @@
\endlist \endlist
In addition to the \gui {Format Current File} command, ClangFormat provides In addition to the \uicontrol {Format Current File} command, ClangFormat provides
the \gui {Format Selected Text} command. If you select it when no text is the \uicontrol {Format Selected Text} command. If you select it when no text is
selected, nothing happens. To format the entire file in this case, select selected, nothing happens. To format the entire file in this case, select
the \gui {Format entire file if no text was selected} check box in the the \uicontrol {Format entire file if no text was selected} check box in the
\gui {Clang Format} options. \uicontrol {Clang Format} options.
*/ */

11
doc/src/editors/creator-clang-codemodel.qdoc
View File

@@ -77,7 +77,7 @@
can take a while. can take a while.
To make parsing faster, pre-compiled headers are ignored by default. You can To make parsing faster, pre-compiled headers are ignored by default. You can
specify that Clang processes them in \gui {Code Model} options. specify that Clang processes them in \uicontrol {Code Model} options.
The following services are currently implemented in the experimental Clang The following services are currently implemented in the experimental Clang
code model plugin: code model plugin:
@@ -169,16 +169,17 @@
\list 1 \list 1
\li Select \gui Help > \gui {About Plugins} > \gui {C++} > \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} >
\gui ClangCodeModel to enable the plugin. \uicontrol ClangCodeModel to enable the plugin.
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
\li Select \gui Tools > \gui Options > \gui {C++} > \gui {Code Model}, \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {C++} > \uicontrol {Code Model},
and select the parser to use for files of each type. and select the parser to use for files of each type.
\li To process pre-compiled headers before processing any project files, \li To process pre-compiled headers before processing any project files,
deselect the \gui {Ignore pre-compiled headers} check box. deselect the \uicontrol {Ignore pre-compiled headers} check box.
\endlist \endlist

68
doc/src/editors/creator-coding-edit-mode.qdoc
View File

@@ -30,7 +30,7 @@
\title Working in Edit Mode \title Working in Edit Mode
This section describes how to use the \gui Edit mode. For more information This section describes how to use the \uicontrol Edit mode. For more information
about using the sidebar, see \l{Browsing Project Contents}. about using the sidebar, see \l{Browsing Project Contents}.
\section1 Using the Editor Toolbar \section1 Using the Editor Toolbar
@@ -44,17 +44,17 @@
Use the toolbar to navigate between open files and symbols in use. Use the toolbar to navigate between open files and symbols in use.
To browse backward or forward through your location history, click To browse backward or forward through your location history, click
\inlineimage qtcreator-back.png \inlineimage qtcreator-back.png
(\gui {Go Back}) and \inlineimage qtcreator-forward.png (\uicontrol {Go Back}) and \inlineimage qtcreator-forward.png
(\gui {Go Forward}). (\uicontrol {Go Forward}).
To go to any open file, select it from the \gui{Open files} drop-down menu (1). To go to any open file, select it from the \uicontrol{Open files} drop-down menu (1).
Right-click the menu title and select \gui {Copy Full Path to Clipboard} to Right-click the menu title and select \uicontrol {Copy Full Path to Clipboard} to
copy the path and name of the current file to the clipboard. copy the path and name of the current file to the clipboard.
To jump to any symbol used in the current file, select it from the To jump to any symbol used in the current file, select it from the
\gui Symbols drop-down menu (2). By default, the symbols are displayed in the \uicontrol Symbols drop-down menu (2). By default, the symbols are displayed in the
order in which they appear in the file. Right-click the menu title and order in which they appear in the file. Right-click the menu title and
select \gui {Sort Alphabetically} to arrange the symbols in alphabetic select \uicontrol {Sort Alphabetically} to arrange the symbols in alphabetic
order. order.
To jump to a line and column in the current file, select the line and column To jump to a line and column in the current file, select the line and column
@@ -63,8 +63,8 @@
separated by a colon (:). separated by a colon (:).
To show the file encoding of the current file on the editor toolbar (4), To show the file encoding of the current file on the editor toolbar (4),
select \gui Tools > \gui Options > \gui {Text Editor} > \gui Display > select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} > \uicontrol Display >
\gui {Display file encoding}. \uicontrol {Display file encoding}.
\note Other convenient ways of navigating in \QC are provided by the \note Other convenient ways of navigating in \QC are provided by the
\l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts} \l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts}
@@ -82,21 +82,21 @@
\list \list
\li To split the editor view into a top and bottom view, select \li To split the editor view into a top and bottom view, select
\gui Window > \gui Split, press \key{Ctrl+E, 2}, or select the \uicontrol Window > \uicontrol Split, press \key{Ctrl+E, 2}, or select the
\inlineimage qtcreator-split-button.png \inlineimage qtcreator-split-button.png
(\gui Split) button and then select \gui Split. (\uicontrol Split) button and then select \uicontrol Split.
Split command creates views below the currently active editor view. Split command creates views below the currently active editor view.
\li To split the editor view into adjacent views, select \li To split the editor view into adjacent views, select
\gui Window > \gui{Split Side by Side}, press \key{Ctrl+E, 3}, or \uicontrol Window > \uicontrol{Split Side by Side}, press \key{Ctrl+E, 3}, or
select \gui {Split > Split Side by Side}. select \uicontrol {Split > Split Side by Side}.
Side by side split command creates views to the right of the Side by side split command creates views to the right of the
currently active editor view. currently active editor view.
\li To open the editor in a detached window, press \key{Ctrl+E, 4}, or \li To open the editor in a detached window, press \key{Ctrl+E, 4}, or
select \gui Window > \gui {Open in New Window}. select \uicontrol Window > \uicontrol {Open in New Window}.
The new window behaves basically in the same way as the editor area The new window behaves basically in the same way as the editor area
in the main window. For example, you can split this window, as well. in the main window. For example, you can split this window, as well.
@@ -104,16 +104,16 @@
\endlist \endlist
To move between split views and detached editor windows, select \gui Window To move between split views and detached editor windows, select \uicontrol Window
> \gui{Go to Next Split or Window} or press \key{Ctrl+E, O}. > \uicontrol{Go to Next Split or Window} or press \key{Ctrl+E, O}.
To remove a split view, place the cursor within the view you want to To remove a split view, place the cursor within the view you want to
remove and select \gui Window > \gui{Remove Current Split}, press remove and select \uicontrol Window > \uicontrol{Remove Current Split}, press
\key{Ctrl+E, 0}, or select the \key{Ctrl+E, 0}, or select the
\inlineimage qtcreator-remove-split-button.png \inlineimage qtcreator-remove-split-button.png
(\gui {Remove Split}) button. To remove all but the currently selected split (\uicontrol {Remove Split}) button. To remove all but the currently selected split
view, view,
select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}. select \uicontrol Window > \uicontrol{Remove All Splits} or press \key{Ctrl+E, 1}.
\section1 Using Bookmarks \section1 Using Bookmarks
@@ -121,7 +121,7 @@
\list \list
\li Right-click the line number and select \gui{Toggle Bookmark}. \li Right-click the line number and select \uicontrol{Toggle Bookmark}.
\li Press \key Shift and click the left margin at a line. \li Press \key Shift and click the left margin at a line.
@@ -132,7 +132,7 @@
\image qtcreator-togglebookmark.png \image qtcreator-togglebookmark.png
To add a note to a bookmark, right-click the bookmark and select To add a note to a bookmark, right-click the bookmark and select
\gui{Edit Bookmark}. To view the note, move the mouse pointer over the \uicontrol{Edit Bookmark}. To view the note, move the mouse pointer over the
bookmark. bookmark.
To go to previous bookmark in the current session, press \key{Ctrl+,}. To go to previous bookmark in the current session, press \key{Ctrl+,}.
@@ -146,16 +146,16 @@
opened, you can open the link in the next split by holding \key Ctrl and opened, you can open the link in the next split by holding \key Ctrl and
\key Alt while clicking the symbol. \key Alt while clicking the symbol.
To enable this moving function, select \gui Tools > \gui{Options} > To enable this moving function, select \uicontrol Tools > \uicontrol{Options} >
\gui{Text Editor} > \gui Behavior > \gui{Enable mouse navigation}. \uicontrol{Text Editor} > \uicontrol Behavior > \uicontrol{Enable mouse navigation}.
You can also select the symbol and press \key F2, or right-click the symbol You can also select the symbol and press \key F2, or right-click the symbol
and select \gui {Follow Symbol Under Cursor} to move to its definition or and select \uicontrol {Follow Symbol Under Cursor} to move to its definition or
declaration. This feature is supported for namespaces, classes, functions, declaration. This feature is supported for namespaces, classes, functions,
variables, include statements, and macros. variables, include statements, and macros.
To switch between the definition and declaration of a function, place the To switch between the definition and declaration of a function, place the
cursor on either and press \key {Shift+F2} or right-click and select \gui cursor on either and press \key {Shift+F2} or right-click and select \uicontrol
{Switch Between Function Declaration/Definition}. For example, this allows {Switch Between Function Declaration/Definition}. For example, this allows
you to navigate from anywhere within a function body directly to the function you to navigate from anywhere within a function body directly to the function
declaration. declaration.
@@ -163,9 +163,9 @@
Links are opened in the same split by default. To open links in the next Links are opened in the same split by default. To open links in the next
split, prepend \key {Ctrl+E} to the shortcut. For example, press \key {Ctrl+E,F2} split, prepend \key {Ctrl+E} to the shortcut. For example, press \key {Ctrl+E,F2}
to follow the symbol in the next split. If necessary, the view is to follow the symbol in the next split. If necessary, the view is
automatically split. To change the default behavior, select \gui Tools > automatically split. To change the default behavior, select \uicontrol Tools >
\gui{Options} > \gui{Text Editor} > \gui Display, and then select \uicontrol{Options} > \uicontrol{Text Editor} > \uicontrol Display, and then select
\gui{Always Open Links in Next Split}. Additional symbols are displayed and \uicontrol{Always Open Links in Next Split}. Additional symbols are displayed and
switching between definition and declaration is done in another split. switching between definition and declaration is done in another split.
If you change the default behavior, the shortcuts for opening link targets If you change the default behavior, the shortcuts for opening link targets
in the next split are used to open them in the current split. in the next split are used to open them in the current split.
@@ -173,8 +173,8 @@
\section1 Reparsing Externally Changed Files \section1 Reparsing Externally Changed Files
If source files are modified from outside \QC, the opened files will be If source files are modified from outside \QC, the opened files will be
reparsed automatically. For all other files, you can use \gui{Tools} > reparsed automatically. For all other files, you can use \uicontrol{Tools} >
\gui{C++} > \gui{Reparse Externally Changed Files} to update the code \uicontrol{C++} > \uicontrol{Reparse Externally Changed Files} to update the code
model. model.
\section1 Inspecting the Code Model \section1 Inspecting the Code Model
@@ -185,14 +185,14 @@
inspection. inspection.
To view information about the C++ code model in the To view information about the C++ code model in the
\gui {C++ Code Model Inspector} dialog and write it to a log file, select \uicontrol {C++ Code Model Inspector} dialog and write it to a log file, select
\gui Tools > \gui C++ > \gui {Inspect C++ Code Model} or press \uicontrol Tools > \uicontrol C++ > \uicontrol {Inspect C++ Code Model} or press
\key {Ctrl+Shift+F12}. \key {Ctrl+Shift+F12}.
\QC generates the code model inspection log file in a temporary folder. \QC generates the code model inspection log file in a temporary folder.
\QC underlines semantic errors in olive in the C++ code editor. To \QC underlines semantic errors in olive in the C++ code editor. To
check the correct paths for includes that are not resolved or that are check the correct paths for includes that are not resolved or that are
resolved to the wrong file, select \gui {Project Parts} > resolved to the wrong file, select \uicontrol {Project Parts} >
\gui {Include Paths}. \uicontrol {Include Paths}.
*/ */

6
doc/src/editors/creator-coding.qdoc
View File

@@ -38,7 +38,7 @@
Writing, editing, and navigating in source code are core tasks in Writing, editing, and navigating in source code are core tasks in
application development. Therefore, the code editor is one of the application development. Therefore, the code editor is one of the
key components of \QC. You can use the code editor in the \gui Edit key components of \QC. You can use the code editor in the \uicontrol Edit
mode. mode.
\li \l{Finding} \li \l{Finding}
@@ -65,7 +65,7 @@
You can change the fonts, colors, highlighting, and indentation. You can change the fonts, colors, highlighting, and indentation.
If you are used to the Vim editor, you can even run the main If you are used to the Vim editor, you can even run the main
editor in a manner similar to it in the \gui{FakeVim} mode. editor in a manner similar to it in the \uicontrol{FakeVim} mode.
\endlist \endlist
@@ -82,7 +82,7 @@
\li \l{Comparing Files} \li \l{Comparing Files}
You can use a diff editor to compare two versions of a file and You can use a diff editor to compare two versions of a file and
view the differences side-by-side in the \gui Edit mode. view the differences side-by-side in the \uicontrol Edit mode.
\li \l{Parsing C++ Files} \li \l{Parsing C++ Files}

32
doc/src/editors/creator-diff-editor.qdoc
View File

@@ -39,13 +39,13 @@
\list 1 \list 1
\li Select \gui Tools > \gui Diff. \li Select \uicontrol Tools > \uicontrol Diff.
\li Select two files to compare. \li Select two files to compare.
\endlist \endlist
The differences are output in the \gui Edit mode. Color coding is used to The differences are output in the \uicontrol Edit mode. Color coding is used to
mark changed lines. By default, light red indicates lines that contain mark changed lines. By default, light red indicates lines that contain
removed text (painted a darker red) in the left pane and light green removed text (painted a darker red) in the left pane and light green
indicates lines that contain added text (painted a darker green) in the indicates lines that contain added text (painted a darker green) in the
@@ -54,49 +54,49 @@
To view the differences in a unified view where changed rows are placed To view the differences in a unified view where changed rows are placed
below each other, select below each other, select
\inlineimage qtcreator-switchto-unified-diffeditor.png \inlineimage qtcreator-switchto-unified-diffeditor.png
(\gui {Switch to Unified Diff Editor}). (\uicontrol {Switch to Unified Diff Editor}).
To switch back to the side-by-side view, select To switch back to the side-by-side view, select
\inlineimage qtcreator-switchto-sidebyside-diffeditor.png \inlineimage qtcreator-switchto-sidebyside-diffeditor.png
(\gui {Switch to Side by Side Diff Editor}). (\uicontrol {Switch to Side by Side Diff Editor}).
To change the default colors, select \gui Tools > \gui Options > To change the default colors, select \uicontrol Tools > \uicontrol Options >
\gui {Text Editor} > \gui {Font & Colors}. Create your own color scheme and \uicontrol {Text Editor} > \uicontrol {Font & Colors}. Create your own color scheme and
select new colors for the following options: select new colors for the following options:
\list \list
\li \gui {Diff File Line} sets the color of the line that shows the \li \uicontrol {Diff File Line} sets the color of the line that shows the
path and filename of the changed file. path and filename of the changed file.
\li \gui {Diff Context Line} sets the color of the line that shows \li \uicontrol {Diff Context Line} sets the color of the line that shows
the number of hidden lines between changed lines. the number of hidden lines between changed lines.
\li \gui {Diff Source Line} sets the color of lines that contain removed \li \uicontrol {Diff Source Line} sets the color of lines that contain removed
text. text.
\li \gui {Diff Source Character} sets the color that indicates removed \li \uicontrol {Diff Source Character} sets the color that indicates removed
characters. characters.
\li \gui {Diff Destination Line} sets the color of lines that contain \li \uicontrol {Diff Destination Line} sets the color of lines that contain
added text. added text.
\li \gui {Diff Destination Character} sets the color that indicates \li \uicontrol {Diff Destination Character} sets the color that indicates
added characters. added characters.
\endlist \endlist
To only show text changes, select \gui {Ignore Whitespace}. To only show text changes, select \uicontrol {Ignore Whitespace}.
To expand the context for the changes, set the number of unchanged lines to To expand the context for the changes, set the number of unchanged lines to
show in \gui {Context lines}. Set the value to -1 to show the whole file. show in \uicontrol {Context lines}. Set the value to -1 to show the whole file.
By default, the horizontal scroll bars in the left and right pane are By default, the horizontal scroll bars in the left and right pane are
synchronized. To use them independently of each other, select the synchronized. To use them independently of each other, select the
\inlineimage qtcreator-synchronizefocus.png \inlineimage qtcreator-synchronizefocus.png
(\gui {Synchronize Horizontal Scroll Bars}) button. (\uicontrol {Synchronize Horizontal Scroll Bars}) button.
If the files change outside \QC, select If the files change outside \QC, select
\inlineimage qtcreator-regenerate-index.png \inlineimage qtcreator-regenerate-index.png
(\gui {Reload Editor}) to compare them again and to show the results. (\uicontrol {Reload Editor}) to compare them again and to show the results.
*/ */

34
doc/src/editors/creator-editors-options-text.qdoc
View File

@@ -31,7 +31,7 @@
\title Specifying Text Editor Settings \title Specifying Text Editor Settings
Set the font preferences and apply color schemes for syntax highlighting in Set the font preferences and apply color schemes for syntax highlighting in
\gui {Tools > Options > Text Editor > Font & Colors}. \uicontrol {Tools > Options > Text Editor > Font & Colors}.
\image qtcreator-font-colors.png "Text editor options" \image qtcreator-font-colors.png "Text editor options"
@@ -41,11 +41,11 @@
percentage for viewing the text. You can also zoom in or out by pressing percentage for viewing the text. You can also zoom in or out by pressing
\key {Ctrl++} or \key {Ctrl +-}, or by pressing \key Ctrl and rolling \key {Ctrl++} or \key {Ctrl +-}, or by pressing \key Ctrl and rolling
the mouse button up or down. To disable the mouse wheel function, select the mouse button up or down. To disable the mouse wheel function, select
\gui {Tools > Options > Text Editor > Behavior} and deselect the \uicontrol {Tools > Options > Text Editor > Behavior} and deselect the
\gui {Enable scroll wheel zooming} check box. \uicontrol {Enable scroll wheel zooming} check box.
Antialiasing is used by default to make text look smoother and more Antialiasing is used by default to make text look smoother and more
readable on the screen. Deselect the \gui Antialias check box to readable on the screen. Deselect the \uicontrol Antialias check box to
turn off antialiasing. turn off antialiasing.
\section2 Defining Color Schemes \section2 Defining Color Schemes
@@ -58,17 +58,17 @@
\list 1 \list 1
\li Select \gui {Tools > Options > Text Editor > Fonts & Color > Copy}. \li Select \uicontrol {Tools > Options > Text Editor > Fonts & Color > Copy}.
\li Enter a name for the color scheme and click \gui OK. \li Enter a name for the color scheme and click \uicontrol OK.
\li In the \gui Foreground field, specify the color of the selected \li In the \uicontrol Foreground field, specify the color of the selected
code element. code element.
\li In the \gui Background field, select the background \li In the \uicontrol Background field, select the background
color for the code element. color for the code element.
The backgound of the \gui Text element determines the background of the The backgound of the \uicontrol Text element determines the background of the
code editor. code editor.
\endlist \endlist
@@ -79,18 +79,18 @@
\section2 File Encoding \section2 File Encoding
To define the default file encoding, select \gui Tools > \gui Options > To define the default file encoding, select \uicontrol Tools > \uicontrol Options >
\gui {Text Editor} > \gui Behavior, and then select a suitable option in \uicontrol {Text Editor} > \uicontrol Behavior, and then select a suitable option in
\gui {Default encoding}. \uicontrol {Default encoding}.
Qt 5 requires UTF-8 encoded source files, and therefore the default Qt 5 requires UTF-8 encoded source files, and therefore the default
encoding was changed from \gui System to \gui UTF-8 in \QC version 2.6. encoding was changed from \uicontrol System to \uicontrol UTF-8 in \QC version 2.6.
However, the \gui {Default encoding} field still displays the value However, the \uicontrol {Default encoding} field still displays the value
\gui System if the default system encoding is set to UTF-8. \uicontrol System if the default system encoding is set to UTF-8.
Detecting the correct encoding is tricky, so \QC will not try to do so. Detecting the correct encoding is tricky, so \QC will not try to do so.
Instead, it displays the following error message when you try to edit a file Instead, it displays the following error message when you try to edit a file
that is not UTF-8 encoded: \gui {Error: Could not decode "filename" with that is not UTF-8 encoded: \uicontrol {Error: Could not decode "filename" with
"UTF-8"-encoding. Editing not possible.} "UTF-8"-encoding. Editing not possible.}
To resolve the issue, use a file conversion tool such as To resolve the issue, use a file conversion tool such as
@@ -100,6 +100,6 @@
If you develop only Qt 4 applications or other than Qt applications, you If you develop only Qt 4 applications or other than Qt applications, you
can set other encoding options as the default encoding. Select the can set other encoding options as the default encoding. Select the
\gui System option to use the file encoding used by your system. \uicontrol System option to use the file encoding used by your system.
*/ */

20
doc/src/editors/creator-editors-options.qdoc
View File

@@ -31,11 +31,11 @@
\title Configuring the Editor \title Configuring the Editor
\QC allows you to configure the text editor to suit your specific \QC allows you to configure the text editor to suit your specific
needs. To configure the editor, select \gui Tools > \gui{Options} > needs. To configure the editor, select \uicontrol Tools > \uicontrol{Options} >
\gui{Text Editor}. \uicontrol{Text Editor}.
These settings apply to all projects. To specify editor behavior for an These settings apply to all projects. To specify editor behavior for an
open project, select \gui Projects > \gui Editor. For more open project, select \uicontrol Projects > \uicontrol Editor. For more
information, see \l{Specifying Editor Settings}. information, see \l{Specifying Editor Settings}.
You can also specify indentation settings separately for C++ and QML files You can also specify indentation settings separately for C++ and QML files
@@ -47,28 +47,28 @@
\list \list
\li Set the \l{Specifying Text Editor Settings}{font preferences and \li Set the \l{Specifying Text Editor Settings}{font preferences and
apply color schemes} for syntax highlighting in \gui{Font & Colors}. apply color schemes} for syntax highlighting in \uicontrol{Font & Colors}.
\li Specify \l{Generic Highlighting} \li Specify \l{Generic Highlighting}
{definition files for syntax highlighting} for other types of files {definition files for syntax highlighting} for other types of files
than C++ or QML in \gui{Generic Highlighter}. than C++ or QML in \uicontrol{Generic Highlighter}.
\li Set \l{Indenting Text or Code}{tabs, indentation, the handling of \li Set \l{Indenting Text or Code}{tabs, indentation, the handling of
whitespace, and mouse operations} in \gui Behavior. whitespace, and mouse operations} in \uicontrol Behavior.
\li Set various display properties, for example, \li Set various display properties, for example,
\l{Highlighting and folding blocks} \l{Highlighting and folding blocks}
{highlighting and folding blocks}, text wrapping or {highlighting and folding blocks}, text wrapping or
\l{Moving to symbol definition or declaration} \l{Moving to symbol definition or declaration}
{moving to symbol definition or declaration} in \gui Display. {moving to symbol definition or declaration} in \uicontrol Display.
\li Add, modify, and remove \l{Editing Code Snippets}{code snippets} in \li Add, modify, and remove \l{Editing Code Snippets}{code snippets} in
\gui Snippets. \uicontrol Snippets.
\li View and remove \l{Using Text Editing Macros}{text editing macros} \li View and remove \l{Using Text Editing Macros}{text editing macros}
in \gui Macros. in \uicontrol Macros.
\li Configure \l{Completing Code}{code completion} in \gui Completion. \li Configure \l{Completing Code}{code completion} in \uicontrol Completion.
\endlist \endlist

347
doc/src/editors/creator-editors.qdoc
View File

@@ -48,7 +48,7 @@
\endlist \endlist
To specify the color scheme to use for semantic highlighting, select To specify the color scheme to use for semantic highlighting, select
\gui {Tools > Options > Text Editor > Fonts & Color}. \uicontrol {Tools > Options > Text Editor > Fonts & Color}.
\QC supports syntax highlighting also for other types of files than \QC supports syntax highlighting also for other types of files than
C++, QML, or JavaScript. C++, QML, or JavaScript.
@@ -78,35 +78,35 @@
\list 1 \list 1
\li Select \gui {Tools > Options > Text Editor > Generic \li Select \uicontrol {Tools > Options > Text Editor > Generic
Highlighter}. Highlighter}.
\image qtcreator-generic-highlighter.png "Generic Highlighter options" \image qtcreator-generic-highlighter.png "Generic Highlighter options"
\li In the \gui Location field, specify the path to the primary \li In the \uicontrol Location field, specify the path to the primary
location for highlight definition files. location for highlight definition files.
\li Click \gui {Download Definitions} to open a list of highlight \li Click \uicontrol {Download Definitions} to open a list of highlight
definition files available for download. definition files available for download.
\image qtcreator-manage-definitions.png "Download Definitions dialog" \image qtcreator-manage-definitions.png "Download Definitions dialog"
\li Select highlight definition files in the list and click \li Select highlight definition files in the list and click
\gui {Download Selected Definitions}. \uicontrol {Download Selected Definitions}.
\li Select the \gui {Use fallback location} check box to specify the \li Select the \uicontrol {Use fallback location} check box to specify the
secondary location where the editor will look for highlight secondary location where the editor will look for highlight
definition files. definition files.
\li Click \gui Autodetect to allow \QC to look for highlight \li Click \uicontrol Autodetect to allow \QC to look for highlight
definition files on your system, or click \gui Browse to locate definition files on your system, or click \uicontrol Browse to locate
them in the file system yourself. them in the file system yourself.
\li In the \gui {Ignored file patterns} field, specify file patterns to \li In the \uicontrol {Ignored file patterns} field, specify file patterns to
suppress alerts if the highlight definitions for the suppress alerts if the highlight definitions for the
specified files are not found. specified files are not found.
\li Click \gui OK to save your changes. \li Click \uicontrol OK to save your changes.
\endlist \endlist
@@ -118,22 +118,22 @@
\image qtcreator-blockhighlighting.png \image qtcreator-blockhighlighting.png
To enable block highlighting, select \gui Tools > \gui{Options} > To enable block highlighting, select \uicontrol Tools > \uicontrol{Options} >
\gui{Text Editor} > \gui Display > \gui{Highlight blocks}. \uicontrol{Text Editor} > \uicontrol Display > \uicontrol{Highlight blocks}.
Use the folding markers to collapse and expand blocks of code within Use the folding markers to collapse and expand blocks of code within
braces. Click the folding marker to collapse or expand a block. In the braces. Click the folding marker to collapse or expand a block. In the
figure above, the folding markers are located between the line number and figure above, the folding markers are located between the line number and
the text pane. the text pane.
To show the folding markers, select \gui Tools > \gui{Options} > To show the folding markers, select \uicontrol Tools > \uicontrol{Options} >
\gui{Text Editor} > \gui Display > \gui{Display folding markers}. This \uicontrol{Text Editor} > \uicontrol Display > \uicontrol{Display folding markers}. This
option is enabled by default. option is enabled by default.
When the cursor is on a brace, the matching brace is animated When the cursor is on a brace, the matching brace is animated
by default. To turn off the animation and just highlight the block and by default. To turn off the animation and just highlight the block and
the braces, select \gui {Tools > Options > Text Editor > Display} and the braces, select \uicontrol {Tools > Options > Text Editor > Display} and
deselect \gui {Animate matching parentheses}. deselect \uicontrol {Animate matching parentheses}.
*/ */
@@ -194,9 +194,9 @@
\section1 Checking JavaScript and QML Syntax \section1 Checking JavaScript and QML Syntax
To run the checks, select \gui {Tools > QML/JS > Run Checks} or press To run the checks, select \uicontrol {Tools > QML/JS > Run Checks} or press
\key Ctrl+Shift+C. The results are shown in the \gui {QML Analysis} \key Ctrl+Shift+C. The results are shown in the \uicontrol {QML Analysis}
filter of the \gui {Issues} output pane. filter of the \uicontrol {Issues} output pane.
\section1 List of JavaScript and QML Checks \section1 List of JavaScript and QML Checks
@@ -742,10 +742,10 @@
You can see the error message when you move the mouse pointer over code that You can see the error message when you move the mouse pointer over code that
\QC underlines in the code editor or when you open a QML file in the \QC underlines in the code editor or when you open a QML file in the
\gui Design mode. \uicontrol Design mode.
To reset the code model, select \gui Tools > \gui {QML/JS} > To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} >
\gui {Reset Code Model}. \uicontrol {Reset Code Model}.
If this does not help, try changing the QML emulation layer to the one that If this does not help, try changing the QML emulation layer to the one that
was built with the same Qt version as the one selected in the build and run was built with the same Qt version as the one selected in the build and run
@@ -774,12 +774,13 @@
When completion is invoked manually, \QC completes the common prefix When completion is invoked manually, \QC completes the common prefix
of the list of suggestions. This is especially useful for classes with of the list of suggestions. This is especially useful for classes with
several similarly named members. To disable this functionality, uncheck several similarly named members. To disable this functionality, uncheck
\gui{Autocomplete common prefix} in the code completion preferences. \uicontrol{Autocomplete common prefix} in the code completion preferences.
Select \gui Tools > \gui{Options} > \gui{Text Editor} > \gui Completion. Select \uicontrol Tools > \uicontrol{Options} > \uicontrol{Text Editor}
> \uicontrol Completion.
By default, code completion considers only the first letter case-sensitive. By default, code completion considers only the first letter case-sensitive.
To apply full or no case-sensitivity, select the option in the To apply full or no case-sensitivity, select the option in the
\gui {Case-sensitivity} field. \uicontrol {Case-sensitivity} field.
\section2 Summary of Available Types \section2 Summary of Available Types
@@ -864,7 +865,7 @@
Code snippets specify C++ or QML code constructs. You can add, modify, Code snippets specify C++ or QML code constructs. You can add, modify,
and remove snippets in the snippet editor. To open the editor, select and remove snippets in the snippet editor. To open the editor, select
\gui {Tools > Options > Text Editor > Snippets}. \uicontrol {Tools > Options > Text Editor > Snippets}.
\image qtcreator-edit-code-snippets.png "Snippet options" \image qtcreator-edit-code-snippets.png "Snippet options"
@@ -884,7 +885,7 @@
\section3 Adding and Editing Snippets \section3 Adding and Editing Snippets
Select a snippet in the list to edit it in the snippet editor. To add a new Select a snippet in the list to edit it in the snippet editor. To add a new
snippet, select \gui Add. Specify a trigger and, if the trigger is already snippet, select \uicontrol Add. Specify a trigger and, if the trigger is already
in use, an optional variant, which appear in the list of suggestions when in use, an optional variant, which appear in the list of suggestions when
you write code. Also specify a text string or C++ or QML code construct in you write code. Also specify a text string or C++ or QML code construct in
the snippet editor, depending on the snippet category. the snippet editor, depending on the snippet category.
@@ -937,7 +938,7 @@
or add. However, when you use the snippets, the code editor marks any or add. However, when you use the snippets, the code editor marks any
errors by underlining them in red. errors by underlining them in red.
To discard the changes you made to a built-in snippet, select \gui {Revert To discard the changes you made to a built-in snippet, select \uicontrol {Revert
Built-in}. Built-in}.
\section3 Removing Snippets \section3 Removing Snippets
@@ -948,15 +949,15 @@
can restore them. can restore them.
To remove snippets, select a snippet in the list, and then select To remove snippets, select a snippet in the list, and then select
\gui Remove. To restore the removed snippets, select \gui {Restore Removed \uicontrol Remove. To restore the removed snippets, select \uicontrol {Restore Removed
Built-ins}. Built-ins}.
\section3 Resetting Snippets \section3 Resetting Snippets
To remove all added snippets and to restore all removed snippets, select To remove all added snippets and to restore all removed snippets, select
\gui {Reset All}. \uicontrol {Reset All}.
\note If you now select \gui OK or \gui Apply, you permanently lose all \note If you now select \uicontrol OK or \uicontrol Apply, you permanently lose all
your own snippets. your own snippets.
*/ */
@@ -976,13 +977,13 @@
\list \list
\li \gui{Pastebin.Com} \li \uicontrol{Pastebin.Com}
\li \gui{Pastebin.Ca} \li \uicontrol{Pastebin.Ca}
\li \gui{Paste.KDE.Org} \li \uicontrol{Paste.KDE.Org}
\li \gui{Shared network drives} \li \uicontrol{Shared network drives}
\endlist \endlist
@@ -992,57 +993,57 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui{Code Pasting}. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol{Code Pasting}.
\image qtcreator-code-pasting-options.png "Code Pasting options" \image qtcreator-code-pasting-options.png "Code Pasting options"
\li In the \gui {Default protocol} field, select a code pasting service \li In the \uicontrol {Default protocol} field, select a code pasting service
to use by default. to use by default.
\li In the \gui Username field, enter your username. \li In the \uicontrol Username field, enter your username.
\li In the \gui {Expires after} field, specify the time to keep the \li In the \uicontrol {Expires after} field, specify the time to keep the
pasted snippet on the server. pasted snippet on the server.
\li Select the \gui {Copy-paste URL to clipboard} check box to copy the \li Select the \uicontrol {Copy-paste URL to clipboard} check box to copy the
URL of the post on the code pasting service to the clipboard when URL of the post on the code pasting service to the clipboard when
you paste a post. you paste a post.
\li Select the \gui {Display Output pane after sending a post} to \li Select the \uicontrol {Display Output pane after sending a post} to
display the URL in the \gui {General Messages} output pane when you display the URL in the \uicontrol {General Messages} output pane when you
paste a post. paste a post.
\endlist \endlist
Select \gui Fileshare to specify the path to a shared Select \uicontrol Fileshare to specify the path to a shared
network drive. The code snippets are copied to the drive as simple files. network drive. The code snippets are copied to the drive as simple files.
You have to delete obsolete files from the drive manually. You have to delete obsolete files from the drive manually.
\section1 Using Code Pasting Services \section1 Using Code Pasting Services
To paste a snippet of code onto the server, select \gui{Tools} > To paste a snippet of code onto the server, select \uicontrol{Tools} >
\gui{Code Pasting} > \gui{Paste Snippet} or press \key{Alt+C,Alt+P}. \uicontrol{Code Pasting} > \uicontrol{Paste Snippet} or press \key{Alt+C,Alt+P}.
By default, \QC copies the URL of the snippet to the clipboard and displays By default, \QC copies the URL of the snippet to the clipboard and displays
the URL in the \gui {General Messages} output pane. the URL in the \uicontrol {General Messages} output pane.
To paste any content that you copied to the clipboard, select \gui Tools > To paste any content that you copied to the clipboard, select \uicontrol Tools >
\gui {Code Pasting} > \gui {Paste Snippet}. \uicontrol {Code Pasting} > \uicontrol {Paste Snippet}.
To fetch a snippet of code from the server, select \gui{Tools} > To fetch a snippet of code from the server, select \uicontrol{Tools} >
\gui{Code Pasting} > \gui{Fetch Snippet} or press \key{Alt+C,Alt+F}. Select \uicontrol{Code Pasting} > \uicontrol{Fetch Snippet} or press \key{Alt+C,Alt+F}. Select
the snippet to fetch from the list. the snippet to fetch from the list.
To fetch the content stored at an URL, select \gui Tools > To fetch the content stored at an URL, select \uicontrol Tools >
\gui {Code Pasting} > \gui {Fetch from URL}. \uicontrol {Code Pasting} > \uicontrol {Fetch from URL}.
For example, you might ask colleagues to review a change that you plan to For example, you might ask colleagues to review a change that you plan to
submit to a version control system. If you use the Git version control submit to a version control system. If you use the Git version control
system, you can create a \e{diff} view by selecting \gui{Tools > Git > system, you can create a \e{diff} view by selecting \uicontrol{Tools > Git >
Diff Repository}. You can then upload its contents to the server by choosing Diff Repository}. You can then upload its contents to the server by choosing
\gui{Tools} > \gui{Code Pasting} > \gui{Paste Snippet}. The reviewers can \uicontrol{Tools} > \uicontrol{Code Pasting} > \uicontrol{Paste Snippet}. The reviewers can
retrieve the code snippet by selecting \gui{Tools > Code Pasting > retrieve the code snippet by selecting \uicontrol{Tools > Code Pasting >
Fetch Snippet}. If they have the project currently opened in \QC, they can Fetch Snippet}. If they have the project currently opened in \QC, they can
apply and test the change by choosing \gui{Tools > Git > Apply Patch}. apply and test the change by choosing \uicontrol{Tools > Git > Apply Patch}.
*/ */
@@ -1055,25 +1056,25 @@
\title Using Text Editing Macros \title Using Text Editing Macros
To record a text editing macro, select \gui {Tools > Macros > Record Macro} To record a text editing macro, select \uicontrol {Tools > Macros > Record Macro}
or press \key {Alt+(}. To stop recording, select \gui {Tools > Macros > or press \key {Alt+(}. To stop recording, select \uicontrol {Tools > Macros >
Stop Recording Macro} or press \key {Alt+)}. Stop Recording Macro} or press \key {Alt+)}.
\note The macro recorder does not support code completion. \note The macro recorder does not support code completion.
To play the last macro, select \gui {Tools > Macros > Play Last Macro} or To play the last macro, select \uicontrol {Tools > Macros > Play Last Macro} or
press \key {Alt+R}. press \key {Alt+R}.
To save the last macro, select \gui {Tools > Macros > Save Last Macro}. To save the last macro, select \uicontrol {Tools > Macros > Save Last Macro}.
To assign a keyboard shortcut to a text editing macro, select \gui {Tools > To assign a keyboard shortcut to a text editing macro, select \uicontrol {Tools >
Options > Environment > Keyboard}. For more information, see Options > Environment > Keyboard}. For more information, see
\l{Configuring Keyboard Shortcuts}. \l{Configuring Keyboard Shortcuts}.
You can also use the \c rm locator filter to run a macro. For more You can also use the \c rm locator filter to run a macro. For more
information, see \l{Searching with the Locator}. information, see \l{Searching with the Locator}.
To view and remove saved macros, select \gui {Tools > Options > Text To view and remove saved macros, select \uicontrol {Tools > Options > Text
Editor > Macros}. Editor > Macros}.
*/ */
@@ -1087,43 +1088,43 @@
\title Using FakeVim Mode \title Using FakeVim Mode
In the \gui{FakeVim} mode, you can run the main editor in a manner similar In the \uicontrol{FakeVim} mode, you can run the main editor in a manner similar
to the Vim editor. To run the editor in the \gui{FakeVim} mode, select to the Vim editor. To run the editor in the \uicontrol{FakeVim} mode, select
\gui{Edit} > \gui{Advanced} > \gui{Use Vim-style Editing} or press \uicontrol{Edit} > \uicontrol{Advanced} > \uicontrol{Use Vim-style Editing} or press
\key{Alt+V,Alt+V}. \key{Alt+V,Alt+V}.
In the \gui{FakeVim} mode, most keystrokes in the main editor will be In the \uicontrol{FakeVim} mode, most keystrokes in the main editor will be
intercepted and interpreted in a way that resembles Vim. Documentation for intercepted and interpreted in a way that resembles Vim. Documentation for
Vim is not included in \QC. For more information on using Vim, Vim is not included in \QC. For more information on using Vim,
see \l{http://www.vim.org/docs.php}{Documentation} on the Vim web site. see \l{http://www.vim.org/docs.php}{Documentation} on the Vim web site.
To map commands entered on the \gui{FakeVim} command line to actions of the To map commands entered on the \uicontrol{FakeVim} command line to actions of the
\QC core, select \gui{Tools} > \gui{Options} > \gui{FakeVim} > \QC core, select \uicontrol{Tools} > \uicontrol{Options} > \uicontrol{FakeVim} >
\gui{Ex Command Mapping}. \uicontrol{Ex Command Mapping}.
To map \e {user commands} to keyboard shortcuts, select \gui{Tools > Options To map \e {user commands} to keyboard shortcuts, select \uicontrol{Tools > Options
> FakeVim > User Command Mapping}. The user command mapped to the shortcut > FakeVim > User Command Mapping}. The user command mapped to the shortcut
is executed by FakeVim as if you were typing it (as when replaying a macro). is executed by FakeVim as if you were typing it (as when replaying a macro).
To make changes to the Vim-style settings, select \gui{Tools} > To make changes to the Vim-style settings, select \uicontrol{Tools} >
\gui{Options} > \gui FakeVim > \gui{General}. \uicontrol{Options} > \uicontrol FakeVim > \uicontrol{General}.
\image qtcreator-fakevim-options.png "FakeVim options" \image qtcreator-fakevim-options.png "FakeVim options"
To preselect the indentation settings specified for the text editor, select To preselect the indentation settings specified for the text editor, select
\gui {Copy Text Editor Settings}. To preselect the Qt coding style, select \uicontrol {Copy Text Editor Settings}. To preselect the Qt coding style, select
\gui {Set Qt Style}. To preselect a simple indentation style, select \uicontrol {Set Qt Style}. To preselect a simple indentation style, select
\gui {Set Plain Style}. You can then change any of the preselected settings. \uicontrol {Set Plain Style}. You can then change any of the preselected settings.
To use a Vim-style color scheme, select \gui {Tools > Options > To use a Vim-style color scheme, select \uicontrol {Tools > Options >
Text Editor > Fonts & Color}. In the \gui {Color Scheme} list, select Text Editor > Fonts & Color}. In the \uicontrol {Color Scheme} list, select
\gui {Vim (dark)}. \uicontrol {Vim (dark)}.
To quit the FakeVim mode, unselect \gui{Tools} > \gui{Options} > To quit the FakeVim mode, unselect \uicontrol{Tools} > \uicontrol{Options} >
\gui{FakeVim} > \gui {Use FakeVim} or press \key{Alt+V,Alt+V}. \uicontrol{FakeVim} > \uicontrol {Use FakeVim} or press \key{Alt+V,Alt+V}.
You can temporarily escape FakeVim mode to access the normal \QC You can temporarily escape FakeVim mode to access the normal \QC
keyboard shortcuts like \key{Ctrl-R} for \gui{Run} by pressing keyboard shortcuts like \key{Ctrl-R} for \uicontrol{Run} by pressing
\key{,} first. \key{,} first.
*/ */
@@ -1163,16 +1164,16 @@
\list 1 \list 1
\li Select \gui {Tools > Options > C++}. \li Select \uicontrol {Tools > Options > C++}.
\li In the \gui {Current settings} field, select the settings to modify \li In the \uicontrol {Current settings} field, select the settings to modify
and click \gui Copy. and click \uicontrol Copy.
\image qtcreator-options-code-style-cpp.png "C++ Code Style options" \image qtcreator-options-code-style-cpp.png "C++ Code Style options"
\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" \image qtcreator-code-style-settings-edit-cpp.png "Edit Code Style Settings dialog"
@@ -1201,7 +1202,7 @@
You can use the live preview to see how the options change the indentation. You can use the live preview to see how the options change the indentation.
To specify different settings for a particular project, select \gui {Projects > To specify different settings for a particular project, select \uicontrol {Projects >
Code Style Settings}. Code Style Settings}.
\section1 Indenting QML Files \section1 Indenting QML Files
@@ -1210,16 +1211,16 @@
\list 1 \list 1
\li Select \gui {Tools > Options >Qt Quick}. \li Select \uicontrol {Tools > Options >Qt Quick}.
\li In the \gui {Current settings} field, select the settings to modify \li In the \uicontrol {Current settings} field, select the settings to modify
and click \gui Copy. and click \uicontrol Copy.
\image qtcreator-options-code-style-qml.png "QML Code Style options" \image qtcreator-options-code-style-qml.png "QML Code Style options"
\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-qtquick.png "Edit Code Style Settings dialog" \image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings dialog"
@@ -1228,18 +1229,18 @@
You can specify how to interpret the \key Tab key presses and how to align You can specify how to interpret the \key Tab key presses and how to align
continuation lines. continuation lines.
To specify different settings for a particular project, select \gui {Projects > To specify different settings for a particular project, select \uicontrol {Projects >
Code Style Settings}. Code Style Settings}.
\section1 Indenting Other Text Files \section1 Indenting Other Text Files
To specify indentation settings for text files that do not contain C++ or QML code (such To specify indentation settings for text files that do not contain C++ or QML code (such
as Python code files), select \gui {Tools > Options > Text Editor > Behavior}. as Python code files), select \uicontrol {Tools > Options > Text Editor > Behavior}.
\image qtcreator-indentation.png "Text Editor Behavior options" \image qtcreator-indentation.png "Text Editor Behavior options"
To specify different settings for a particular project, select \gui Projects To specify different settings for a particular project, select \uicontrol Projects
> \gui Editor. > \uicontrol Editor.
You can specify how to interpret the \key Tab and \key Backspace key You can specify how to interpret the \key Tab and \key Backspace key
presses and how to align continuation lines. presses and how to align continuation lines.
@@ -1266,8 +1267,8 @@
\section2 Specifying Tabs and Indentation \section2 Specifying Tabs and Indentation
You can specify tab policy and tab size in the \gui Typing group. In the You can specify tab policy and tab size in the \uicontrol Typing group. In the
\gui {Tab policy} field, select whether to use only spaces or only tabs for \uicontrol {Tab policy} field, select whether to use only spaces or only tabs for
indentation, or to use a mixture of them. indentation, or to use a mixture of them.
By default, the tab length in code editor is 8 spaces and the indent size is By default, the tab length in code editor is 8 spaces and the indent size is
@@ -1275,29 +1276,29 @@
project and for different types of files. project and for different types of files.
You can have continuation lines aligned with the previous line. In the You can have continuation lines aligned with the previous line. In the
\gui {Align continuation lines} field, select \gui {Not at all} to disable \uicontrol {Align continuation lines} field, select \uicontrol {Not at all} to disable
automatic alignment and indent continuation lines to the logical depth. automatic alignment and indent continuation lines to the logical depth.
To always use spaces for alignment, select \gui {With Spaces}. To follow the To always use spaces for alignment, select \uicontrol {With Spaces}. To follow the
\gui {Tab policy}, select \gui {With Regular Indent}. \uicontrol {Tab policy}, select \uicontrol {With Regular Indent}.
\section2 Specifying Typing Options \section2 Specifying Typing Options
When you type text or code, it is indented automatically according to the selected When you type text or code, it is indented automatically according to the selected
text editor or code style options. Specify typing options in the text editor or code style options. Specify typing options in the
\gui Typing group. To disable automatic indentation, deselect the \uicontrol Typing group. To disable automatic indentation, deselect the
\gui {Enable automatic indentation} check box. \uicontrol {Enable automatic indentation} check box.
You can specify how the indentation is decreased when you press You can specify how the indentation is decreased when you press
\gui Backspace in the \gui {Backspace indentation} field. To go back one \uicontrol Backspace in the \uicontrol {Backspace indentation} field. To go back one
space at a time, select \gui None. To decrease indentation in leading white space at a time, select \uicontrol None. To decrease indentation in leading white
space by one level, select \gui {Follows Previous Indents}. To move back one space by one level, select \uicontrol {Follows Previous Indents}. To move back one
tab length if the character to the left of the cursor is a space, select tab length if the character to the left of the cursor is a space, select
\gui Unindents. \uicontrol Unindents.
You can specify whether the \key Tab key automatically indents text when you You can specify whether the \key Tab key automatically indents text when you
press it. To automatically indent text, select \gui Always in the press it. To automatically indent text, select \uicontrol Always in the
\gui {Tab key performs auto-indent} field. To only indent text when the \uicontrol {Tab key performs auto-indent} field. To only indent text when the
cursor is located within leading white space, select \gui {In Leading White cursor is located within leading white space, select \uicontrol {In Leading White
Space}. Space}.
\section1 Specifying Settings for Content \section1 Specifying Settings for Content
@@ -1327,8 +1328,8 @@
\section1 Specifying Alignment \section1 Specifying Alignment
To align continuation lines to tokens after assignments, such as = or To align continuation lines to tokens after assignments, such as = or
+=, select the \gui {Align after assignments} check box. You can specify +=, select the \uicontrol {Align after assignments} check box. You can specify
additional settings for aligning continuation lines in the \gui General additional settings for aligning continuation lines in the \uicontrol General
tab. tab.
You can also add spaces to conditional statements, so that they are not You can also add spaces to conditional statements, so that they are not
@@ -1341,7 +1342,7 @@
To bind pointers (*) and references (&) in types and declarations to To bind pointers (*) and references (&) in types and declarations to
identifiers, type names, or left or right \c const or \c volatile keywords, identifiers, type names, or left or right \c const or \c volatile keywords,
select the check boxes in the \gui {Pointers and References} tab. select the check boxes in the \uicontrol {Pointers and References} tab.
The * and & characters are automatically bound to identifiers of pointers to The * and & characters are automatically bound to identifiers of pointers to
functions and pointers to arrays. functions and pointers to arrays.
@@ -1363,63 +1364,63 @@
\list 1 \list 1
\li Press \key Ctrl+F or select \gui Edit > \gui Find/Replace > \li Press \key Ctrl+F or select \uicontrol Edit > \uicontrol Find/Replace >
\gui{Find/Replace}. \uicontrol{Find/Replace}.
\li Enter the text you are looking for. \li Enter the text you are looking for.
If the text is found, all occurrences are highlighted as you type. If the text is found, all occurrences are highlighted as you type.
\li To go to the next occurrence, click \inlineimage qtcreator-next.png \li To go to the next occurrence, click \inlineimage qtcreator-next.png
(\gui {Find Next}), or press \key F3. To go to the previous (\uicontrol {Find Next}), or press \key F3. To go to the previous
occurrence click occurrence click
\inlineimage qtcreator-previous.png \inlineimage qtcreator-previous.png
(\gui {Find Previous}), or press \key Shift+F3. (\uicontrol {Find Previous}), or press \key Shift+F3.
\endlist \endlist
You can restrict the search in the \gui Find field by selecting one You can restrict the search in the \uicontrol Find field by selecting one
or several search criteria: or several search criteria:
\list \list
\li To make your search case sensitive, select \li To make your search case sensitive, select
\gui {Case Sensitive}. \uicontrol {Case Sensitive}.
\li To search only whole words, select \li To search only whole words, select
\gui {Whole Words Only}. \uicontrol {Whole Words Only}.
\li To search using regular expressions, select \li To search using regular expressions, select
\gui {Regular Expressions}. \uicontrol {Regular Expressions}.
Regular expressions used in \QC are modeled on Perl regular Regular expressions used in \QC are modeled on Perl regular
expressions. For more information on using regular expressions, see expressions. For more information on using regular expressions, see
the documentation for the QRegExp Class. the documentation for the QRegExp Class.
\endlist \endlist
\note If you have selected text before selecting \gui {Find/Replace}, the \note If you have selected text before selecting \uicontrol {Find/Replace}, the
search is conducted within the selection. search is conducted within the selection.
To replace occurrences of the existing text, enter the new text in the To replace occurrences of the existing text, enter the new text in the
\gui{Replace with} field. \uicontrol{Replace with} field.
\list \list
\li To replace the selected occurrence and move to the next one, \li To replace the selected occurrence and move to the next one,
click \gui {Find Next} click \uicontrol {Find Next}
or press \key Ctrl+=. or press \key Ctrl+=.
\li To replace the selected occurrence and move to the previous one, \li To replace the selected occurrence and move to the previous one,
click \gui {Find Previous} click \uicontrol {Find Previous}
. .
\li To replace all occurrences in the file, click \gui{Replace All}. \li To replace all occurrences in the file, click \uicontrol{Replace All}.
\endlist \endlist
The \gui{Preserve Case when Replacing} option can be selected to preserve The \uicontrol{Preserve Case when Replacing} option can be selected to preserve
the case of the original text when replacing. This option is not compatible the case of the original text when replacing. This option is not compatible
with the \gui {Regular Expressions} search option, and will thus be with the \uicontrol {Regular Expressions} search option, and will thus be
disabled when regular expressions are used. When the option is used, the disabled when regular expressions are used. When the option is used, the
case of the occurrence will be conserved, according to the following rules: case of the occurrence will be conserved, according to the following rules:
@@ -1445,40 +1446,40 @@
\list 1 \list 1
\li Press \key Ctrl+Shift+F or select \gui Edit > \gui Find/Replace > \li Press \key Ctrl+Shift+F or select \uicontrol Edit > \uicontrol Find/Replace >
\gui{Advanced Find} > \gui{Open Advanced Find}. \uicontrol{Advanced Find} > \uicontrol{Open Advanced Find}.
\li Select the scope of your search: \li Select the scope of your search:
\list \list
\li \gui{All Projects} searches files matching the defined file \li \uicontrol{All Projects} searches files matching the defined file
pattern in all currently open projects. pattern in all currently open projects.
For example, to search for \tt previewer only in \tt .cpp For example, to search for \tt previewer only in \tt .cpp
and \tt .h files, enter in \gui{File pattern} and \tt .h files, enter in \uicontrol{File pattern}
\tt *.cpp,*.h. \tt *.cpp,*.h.
\image qtcreator-search-allprojects.png \image qtcreator-search-allprojects.png
\li \gui{Current Project} searches files matching the defined \li \uicontrol{Current Project} searches files matching the defined
file pattern only in the project you are currently editing. file pattern only in the project you are currently editing.
\li \gui{Files on File System} recursively searches files \li \uicontrol{Files on File System} recursively searches files
matching the defined file pattern in the selected directory. matching the defined file pattern in the selected directory.
\li \gui{Current File} searches only the current file. \li \uicontrol{Current File} searches only the current file.
\li \gui {Open Documents} searches all open files. \li \uicontrol {Open Documents} searches all open files.
\endlist \endlist
\li Enter the text you are looking for and click \gui Search. \li Enter the text you are looking for and click \uicontrol Search.
\image qtcreator-searchresults.png \image qtcreator-searchresults.png
A list of files containing the searched text is displayed in the A list of files containing the searched text is displayed in the
\gui{Search Results} pane. \uicontrol{Search Results} pane.
\list \list
@@ -1488,7 +1489,7 @@
\li To go to an occurrence, double-click it. \li To go to an occurrence, double-click it.
\li To repeat the search after you have made changes to the \li To repeat the search after you have made changes to the
listed files, for example, select \gui {Search Again}. listed files, for example, select \uicontrol {Search Again}.
\endlist \endlist
@@ -1497,7 +1498,7 @@
The search results are stored in the search history from which you can The search results are stored in the search history from which you can
select earlier searches. select earlier searches.
\note You can use \gui{Advanced Find} also to search for symbols. For more \note You can use \uicontrol{Advanced Find} also to search for symbols. For more
information, see \l{Finding Symbols}. information, see \l{Finding Symbols}.
*/ */
@@ -1537,9 +1538,9 @@
\list \list
\li \gui {Tools > C++ > Find Usages} \li \uicontrol {Tools > C++ > Find Usages}
\li \gui {Tools > QML/JS > Find Usages} \li \uicontrol {Tools > QML/JS > Find Usages}
\li \key Ctrl+Shift+U \li \key Ctrl+Shift+U
@@ -1558,14 +1559,14 @@
\endlist \endlist
\note You can also select \gui{Edit > Find/Replace > Advanced Find > \note You can also select \uicontrol{Edit > Find/Replace > Advanced Find >
C++ Symbols} to search for classes, functions, enums, and declarations C++ Symbols} to search for classes, functions, enums, and declarations
either from files listed as part of the project or from all files that either from files listed as part of the project or from all files that
are used by the code, such as include files. are used by the code, such as include files.
\image qtcreator-search-cpp-symbols.png \image qtcreator-search-cpp-symbols.png
\li The \gui{Search Results} pane opens and shows the location and \li The \uicontrol{Search Results} pane opens and shows the location and
number of instances of the symbol in the current project. number of instances of the symbol in the current project.
\image qtcreator-refactoring-find.png \image qtcreator-refactoring-find.png
@@ -1577,13 +1578,13 @@
\list \list
\li To go directly to an instance, double-click the instance in the \li To go directly to an instance, double-click the instance in the
\gui{Search Results} pane. \uicontrol{Search Results} pane.
\li To move between instances, click \li To move between instances, click
\inlineimage qtcreator-forward.png \inlineimage qtcreator-forward.png
and and
\inlineimage qtcreator-back.png \inlineimage qtcreator-back.png
in the \gui{Search Results} pane. in the \uicontrol{Search Results} pane.
\li To expand and collapse the list of all instances, click \li To expand and collapse the list of all instances, click
\inlineimage qtcreator-expand.png \inlineimage qtcreator-expand.png
@@ -1601,28 +1602,28 @@
\list 1 \list 1
\li In the editor, place the cursor on the symbol you would like to \li In the editor, place the cursor on the symbol you would like to
change and select \gui Tools > \gui C++ > change and select \uicontrol Tools > \uicontrol C++ >
\gui{Rename Symbol Under Cursor} or \gui Tools > \gui QML/JS > \uicontrol{Rename Symbol Under Cursor} or \uicontrol Tools > \uicontrol QML/JS >
\gui{Rename Symbol Under Cursor}. Alternatively, press \uicontrol{Rename Symbol Under Cursor}. Alternatively, press
\key Ctrl+Shift+R. \key Ctrl+Shift+R.
The \gui{Search Results} pane opens and shows the location and The \uicontrol{Search Results} pane opens and shows the location and
number of instances of the symbol in the current project. number of instances of the symbol in the current project.
\image qtcreator-refactoring-replace.png \image qtcreator-refactoring-replace.png
\li To replace all selected instances, enter the name of the new symbol \li To replace all selected instances, enter the name of the new symbol
in the \gui{Replace with} text box and click \gui Replace. in the \uicontrol{Replace with} text box and click \uicontrol Replace.
To omit an instance, uncheck the check-box next to the instance. To omit an instance, uncheck the check-box next to the instance.
\note This action replaces all selected instances of the symbol in \note This action replaces all selected instances of the symbol in
all files listed in the \gui{Search Results} pane. You cannot all files listed in the \uicontrol{Search Results} pane. You cannot
undo this action. undo this action.
\endlist \endlist
\note Renaming local symbols does not open the \gui{Search Results} pane. \note Renaming local symbols does not open the \uicontrol{Search Results} pane.
The instances of the symbol are highlighted in code and you can edit the The instances of the symbol are highlighted in code and you can edit the
symbol. All instances of the local symbol are changed as you type. symbol. All instances of the local symbol are changed as you type.
@@ -1643,10 +1644,10 @@
conditional statement, string, or name to open a context menu. In QML code, conditional statement, string, or name to open a context menu. In QML code,
click an item ID or name. click an item ID or name.
In the context menu, select \gui {Refactoring} and then select a refactoring In the context menu, select \uicontrol {Refactoring} and then select a refactoring
action. action.
You can also press \gui {Alt+Enter} to open a context menu that contains You can also press \uicontrol {Alt+Enter} to open a context menu that contains
refactoring actions available in the current cursor position. refactoring actions available in the current cursor position.
\section2 Refactoring C++ Code \section2 Refactoring C++ Code
@@ -1971,7 +1972,7 @@
\li Extract Function \li Extract Function
\li Moves the selected code to a new function and replaces the block of \li Moves the selected code to a new function and replaces the block of
code with a call to the new function. Enter a name for the function in code with a call to the new function. Enter a name for the function in
the \gui {Extract Function Refactoring} dialog. the \uicontrol {Extract Function Refactoring} dialog.
\li Block of code selected \li Block of code selected
\row \row
\li Extract Constant as Function Parameter \li Extract Constant as Function Parameter
@@ -2268,9 +2269,9 @@
\li Press \key Ctrl+K (\key Cmd+K on OS X). \li Press \key Ctrl+K (\key Cmd+K on OS X).
\li Select \gui Tools > \gui Locate. \li Select \uicontrol Tools > \uicontrol Locate.
\li Select \gui Edit > \gui {Go to Line}. \li Select \uicontrol Edit > \uicontrol {Go to Line}.
\li Click the line and column indicator on the \li Click the line and column indicator on the
\l{Using the Editor Toolbar}{editor toolbar}. \l{Using the Editor Toolbar}{editor toolbar}.
@@ -2409,15 +2410,15 @@
\list 1 \list 1
\li In the locator, click \inlineimage qtcreator-locator-magnify.png \li In the locator, click \inlineimage qtcreator-locator-magnify.png
(\gui {Options}) and select \gui Configure to open the \gui Locator (\uicontrol {Options}) and select \uicontrol Configure to open the \uicontrol Locator
options. options.
\li Select a filter, and then select \gui Edit. \li Select a filter, and then select \uicontrol Edit.
\li Specify the prefix string. \li Specify the prefix string.
\li To show only results matching this filter, select \li To show only results matching this filter, select
\gui{Limit to prefix}. \uicontrol{Limit to prefix}.
\li Specify other available options. For more information, see \li Specify other available options. For more information, see
\l{Adding Web Search Engines}. \l{Adding Web Search Engines}.
@@ -2426,7 +2427,7 @@
\section2 Adding Web Search Engines \section2 Adding Web Search Engines
You can use the \gui {Web Search (\c r)} locator filter to perform You can use the \uicontrol {Web Search (\c r)} locator filter to perform
web searches. URLs and search commands for Bing, Google, Yahoo! Search, web searches. URLs and search commands for Bing, Google, Yahoo! Search,
cplusplus.com, and Wikipedia are configured by default. cplusplus.com, and Wikipedia are configured by default.
@@ -2439,18 +2440,18 @@
\list 1 \list 1
\li Select \gui {Tools > Options > Environment > Locator > \li Select \uicontrol {Tools > Options > Environment > Locator >
Web Search (prefix: r) > Web Search (prefix: r) >
Edit}. Edit}.
\li Select \gui Add to add a new entry to the list. \li Select \uicontrol Add to add a new entry to the list.
\image qtcreator-add-online-doc.png "Filter Configuration dialog" \image qtcreator-add-online-doc.png "Filter Configuration dialog"
\li Double-click the new entry to specify a URL and a search command. \li Double-click the new entry to specify a URL and a search command.
For example, http://www.google.com/search?q=%1. For example, http://www.google.com/search?q=%1.
\li Click \gui OK. \li Click \uicontrol OK.
\endlist \endlist
@@ -2464,14 +2465,14 @@
\list 1 \list 1
\li In the locator, select \gui {Options > Configure} to open the \li In the locator, select \uicontrol {Options > Configure} to open the
\gui Locator options. \uicontrol Locator options.
\image qtcreator-locator-customize.png \image qtcreator-locator-customize.png
\li Click \gui Add. \li Click \uicontrol Add.
\li In the \gui{Filter Configuration} dialog: \li In the \uicontrol{Filter Configuration} dialog:
\list \list
@@ -2486,7 +2487,7 @@
\li Specify the prefix string. \li Specify the prefix string.
To show only results matching this filter, select To show only results matching this filter, select
\gui{Limit to prefix}. \uicontrol{Limit to prefix}.
\image qtcreator-navigate-customfilter.png \image qtcreator-navigate-customfilter.png
@@ -2503,16 +2504,16 @@
all default filters is updated as you write your code. By default, all default filters is updated as you write your code. By default,
\QC updates the filters created by you once an hour. \QC updates the filters created by you once an hour.
To update the cached information manually, select \gui {Options > Refresh} To update the cached information manually, select \uicontrol {Options > Refresh}
in the locator. in the locator.
To set a new cache update time: To set a new cache update time:
\list 1 \list 1
\li Select \gui {Tools > Options > Environment > Locator}. \li Select \uicontrol {Tools > Options > Environment > Locator}.
\li In \gui{Refresh interval}, define new time in minutes. \li In \uicontrol{Refresh interval}, define new time in minutes.
\endlist \endlist

18
doc/src/editors/creator-mime-types.qdoc
View File

@@ -56,35 +56,35 @@
\list 1 \list 1
\li Select \gui {Tools > Options > Environment > MIME Types}. \li Select \uicontrol {Tools > Options > Environment > MIME Types}.
\image qtcreator-mime-types.png "MIME Types" \image qtcreator-mime-types.png "MIME Types"
\li In \gui {MIME Type}, select a MIME type. \li In \uicontrol {MIME Type}, select a MIME type.
\li In \gui Patterns, add the filename extension for the type of files \li In \uicontrol Patterns, add the filename extension for the type of files
that you want to identify as having this MIME type. that you want to identify as having this MIME type.
\li Click \gui Add to add \gui {Magic Headers}. \li Click \uicontrol Add to add \uicontrol {Magic Headers}.
\image qtcreator-mime-types-magic-header.png "Magic Header" \image qtcreator-mime-types-magic-header.png "Magic Header"
\li In the \gui Value field, specify a text string or bytes that \li In the \uicontrol Value field, specify a text string or bytes that
appear in the files. appear in the files.
\li In the \gui Type field, select the type of the value. \li In the \uicontrol Type field, select the type of the value.
\note You are recommended not to change the range and priority, \note You are recommended not to change the range and priority,
because it might cause problems when opening files in \QC. because it might cause problems when opening files in \QC.
\li Click \gui OK. \li Click \uicontrol OK.
\endlist \endlist
To revert all the changes you have made to the MIME type definitions, To revert all the changes you have made to the MIME type definitions,
select \gui {Reset All}. select \uicontrol {Reset All}.
\note If you now select \gui OK or \gui Apply, you permanently lose all \note If you now select \uicontrol OK or \uicontrol Apply, you permanently lose all
your own patterns and magic headers. The changes are reverted the next your own patterns and magic headers. The changes are reverted the next
time you start \QC. time you start \QC.

49
doc/src/howto/creator-external-tools.qdoc
View File

@@ -45,15 +45,15 @@
To synchronize translation source (TS) files from a translator with the To synchronize translation source (TS) files from a translator with the
application code, application code,
select \gui {Tools > External > Text > Linguist > Update Translations select \uicontrol {Tools > External > Text > Linguist > Update Translations
(lupdate)}. (lupdate)}.
To generate from the TS files Qt message (QM) files that can be used by an To generate from the TS files Qt message (QM) files that can be used by an
application, select \gui {Tools > External > Text > Linguist > Release application, select \uicontrol {Tools > External > Text > Linguist > Release
Translations (lrelease)}. Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \gui {Tools > specify other command line arguments for the tools, select \uicontrol {Tools >
External > Configure}. External > Configure}.
For more information about Qt Linguist, see \l{Qt Linguist Manual}. For more information about Qt Linguist, see \l{Qt Linguist Manual}.
@@ -64,77 +64,78 @@
QML Scene (Qt Quick 2). The preview tools enable you to load QML documents QML Scene (Qt Quick 2). The preview tools enable you to load QML documents
for viewing and testing while you are developing an application. for viewing and testing while you are developing an application.
To preview the currently active QML file, select \gui Tools > \gui External To preview the currently active QML file, select \uicontrol Tools >
> \gui {Qt Quick} > \gui {Qt Quick 1 Preview (qmlviewer)} or \uicontrol External > \uicontrol {Qt Quick} > \uicontrol {Qt Quick 1 Preview
\gui {Qt Quick 2 Preview (qmlscene)}. (qmlviewer)} or \uicontrol {Qt Quick 2 Preview (qmlscene)}.
\section1 Using External Text Editors \section1 Using External Text Editors
You can open files for editing in the default text editor for your system: You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and OS X. Notepad on Windows and vi on Linux and OS X.
To open the file you are currently viewing in an external editor, select To open the file you are currently viewing in an external editor, select
\gui Tools > \gui External > \gui Text > \gui {Edit with Notepad} or \uicontrol Tools > \uicontrol External > \uicontrol Text >
\gui {Edit with vi}, depending on your system. \uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
your system.
\QC looks for the editor path in the PATH environment variable \QC looks for the editor path in the PATH environment variable
of your operating system. of your operating system.
\section1 Sorting Text Alphabetically \section1 Sorting Text Alphabetically
To sort selected text alphabetically, select \gui {Tools > External > Text To sort selected text alphabetically, select \uicontrol {Tools > External > Text
> Sort Selection}. The \c sort tool takes the selected text as input and > Sort Selection}. The \c sort tool takes the selected text as input and
returns it in alphabetic order. By default, the output replaces the returns it in alphabetic order. By default, the output replaces the
original selection in the code editor. original selection in the code editor.
To change the default configuration, select \gui {Tools > External > To change the default configuration, select \uicontrol {Tools > External >
Configure}. Configure}.
\section1 Configuring External Tools \section1 Configuring External Tools
You can change the configuration of preconfigured tools and configure You can change the configuration of preconfigured tools and configure
additional tools in \QC \gui Options. additional tools in \QC \uicontrol Options.
To configure external tools: To configure external tools:
\list 1 \list 1
\li Select \gui {Tools > External > Configure}. \li Select \uicontrol {Tools > External > Configure}.
\li Select \gui {Add > Add Tool} \li Select \uicontrol {Add > Add Tool}
to add a new tool. You can also select \gui {Add Category} to add a to add a new tool. You can also select \uicontrol {Add Category} to add a
new category. new category.
\li In the \gui Executable field, specify the executable to run. If the \li In the \uicontrol Executable field, specify the executable to run. If the
executable is found in your system PATH variable, do not specify executable is found in your system PATH variable, do not specify
the path to it. the path to it.
\li In the \gui Arguments field, specify optional arguments for running \li In the \uicontrol Arguments field, specify optional arguments for running
the executable. the executable.
\li In the \gui {Working directory} field, specify the path to the \li In the \uicontrol {Working directory} field, specify the path to the
working directory. working directory.
\li In the \gui {Output pane}, select how to handle output from the \li In the \uicontrol {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \gui {General tool. You can ignore the output, view it in the \uicontrol {General
Messages} output pane, or replace the selected text with the Messages} output pane, or replace the selected text with the
output in the code editor. output in the code editor.
\li In the \gui {Error output pane}, select how to handle error messages \li In the \uicontrol {Error output pane}, select how to handle error messages
from the tool. from the tool.
\li Select the \gui {Modifies current document} check box to make sure \li Select the \uicontrol {Modifies current document} check box to make sure
that if the current document is modified by the tool, it is saved that if the current document is modified by the tool, it is saved
before the tool is run and reloaded after the tool finishes. before the tool is run and reloaded after the tool finishes.
\li In the \gui Input field, specify text that is passed as standard \li In the \uicontrol Input field, specify text that is passed as standard
input to the tool. input to the tool.
\endlist \endlist
The category and tool are added to the \gui {Tools > External} menu. The category and tool are added to the \uicontrol {Tools > External} menu.
If you change the configuration of preconfigured tools, you can later If you change the configuration of preconfigured tools, you can later
revert the changes by selecting the \gui Revert button. revert the changes by selecting the \uicontrol Revert button.
The tool configurations that you add and modify are stored in XML format in The tool configurations that you add and modify are stored in XML format in
the user configuration folder. For example, the user configuration folder. For example,

94
doc/src/howto/creator-help.qdoc
View File

@@ -35,7 +35,7 @@
\list \list
\li To view documentation, switch to \gui Help mode. \li To view documentation, switch to \uicontrol Help mode.
\li To view context sensitive help on a Qt class or function as a \li To view context sensitive help on a Qt class or function as a
tooltip, move the mouse cursor over the class or function. If help tooltip, move the mouse cursor over the class or function. If help
@@ -45,58 +45,58 @@
\li To display the full help on a Qt class or function, press \key F1. \li To display the full help on a Qt class or function, press \key F1.
The documentation is displayed in a The documentation is displayed in a
pane next to the code editor, or, if there is not enough vertical pane next to the code editor, or, if there is not enough vertical
space, in the fullscreen \gui Help mode. space, in the fullscreen \uicontrol Help mode.
\li To select and configure how the documentation is displayed in the \li To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help. \uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help.
\endlist \endlist
The following image displays the context sensitive help in the \gui Edit The following image displays the context sensitive help in the \uicontrol Edit
mode. mode.
\image qtcreator-context-sensitive-help.png \image qtcreator-context-sensitive-help.png
\section1 Viewing Function Tooltips \section1 Viewing Function Tooltips
To hide function tooltips by default, select \gui {Tools > Options > To hide function tooltips by default, select \uicontrol {Tools > Options >
Text Editor > Behavior > Show help tooltips using the mouse > Text Editor > Behavior > Show help tooltips using the mouse >
On Shift+Mouseover}. You On Shift+Mouseover}. You
can still view the tooltips by pressing and holding down the \key Shift can still view the tooltips by pressing and holding down the \key Shift
key. key.
To use a keyboard shortcut for viewing help tooltips, select To use a keyboard shortcut for viewing help tooltips, select
\gui {Show help tooltips using keyboard shortcut (Alt)}. \uicontrol {Show help tooltips using keyboard shortcut (Alt)}.
\section1 Finding Information in Qt Documentation \section1 Finding Information in Qt Documentation
\QC, \QSDK and other Qt deliverables contain documentation \QC, \QSDK and other Qt deliverables contain documentation
as .qch files. All the documentation is accessible in the \gui Help mode. as .qch files. All the documentation is accessible in the \uicontrol Help mode.
To find information in the documentation, select: To find information in the documentation, select:
\list \list
\li \gui Bookmarks to view a list of pages on which you have added \li \uicontrol Bookmarks to view a list of pages on which you have added
bookmarks. bookmarks.
\li \gui Contents to see all the documentation installed on the \li \uicontrol Contents to see all the documentation installed on the
development PC and to browse the documentation contents. development PC and to browse the documentation contents.
\li \gui Index to find information based on a list of keywords in all \li \uicontrol Index to find information based on a list of keywords in all
the installed documents. the installed documents.
\li \gui {Open Pages} to view a list of currently open documentation \li \uicontrol {Open Pages} to view a list of currently open documentation
pages. pages.
\li \gui Search to search from all the installed documents. \li \uicontrol Search to search from all the installed documents.
\endlist \endlist
\section2 Adding Bookmarks to Help Pages \section2 Adding Bookmarks to Help Pages
You can add bookmarks to useful help pages to easily find them later You can add bookmarks to useful help pages to easily find them later
in the \gui Bookmarks view. You can either use the page title as the in the \uicontrol Bookmarks view. You can either use the page title as the
bookmark or change it to any text. You can organize the bookmarks in bookmark or change it to any text. You can organize the bookmarks in
folders in the view. folders in the view.
@@ -108,21 +108,21 @@
\li Click the \li Click the
\inlineimage qtcreator-help-add-bookmark.png \inlineimage qtcreator-help-add-bookmark.png
(\gui {Add Bookmark}) button on the toolbar. (\uicontrol {Add Bookmark}) button on the toolbar.
\li In the \gui {Add Bookmark} dialog, click \gui OK to save the \li In the \uicontrol {Add Bookmark} dialog, click \uicontrol OK to save the
page title as a bookmark in the selected folder. page title as a bookmark in the selected folder.
\endlist \endlist
To import and export bookmarks, select \gui {Tools > Options > Help > To import and export bookmarks, select \uicontrol {Tools > Options > Help >
General Settings > Import} or \gui Export. General Settings > Import} or \uicontrol Export.
\section2 Full-text Search \section2 Full-text Search
In the \gui Search pane, you can use full-text search for finding a In the \uicontrol Search pane, you can use full-text search for finding a
particular word in all the installed documents. In the \gui {Search for} particular word in all the installed documents. In the \uicontrol {Search for}
field, enter the term you are looking for, and select the \gui Search field, enter the term you are looking for, and select the \uicontrol Search
button. All documents that contain the specified term are listed. The list button. All documents that contain the specified term are listed. The list
is sorted by the number of search hits that the documents contain. Select a is sorted by the number of search hits that the documents contain. Select a
document in the list to open it. document in the list to open it.
@@ -147,20 +147,20 @@
\endlist \endlist
For more flexibility, use the \gui {Advanced search}. Specify words to For more flexibility, use the \uicontrol {Advanced search}. Specify words to
exclude from the search hits, or search for an exact phrase or for similar exclude from the search hits, or search for an exact phrase or for similar
words. For example, searching for \c{QStin}, \c{QSting}, or \c{QStrin} lists words. For example, searching for \c{QStin}, \c{QSting}, or \c{QStrin} lists
all the documents with titles that are similar, such as \c{QString}. all the documents with titles that are similar, such as \c{QString}.
Combine options to improve the search results. Combine options to improve the search results.
Full-text search is based on indexing all the installed documents the first Full-text search is based on indexing all the installed documents the first
time when you open the \gui Search pane. If you add or remove documents, time when you open the \uicontrol Search pane. If you add or remove documents,
\QC recreates the index. \QC recreates the index.
If you cannot find words that you know are there, indexing might not have If you cannot find words that you know are there, indexing might not have
been completed for some reason. To regenerate the index, click been completed for some reason. To regenerate the index, click
\inlineimage qtcreator-regenerate-index.png \inlineimage qtcreator-regenerate-index.png
(\gui {Regenerate Index}). (\uicontrol {Regenerate Index}).
Punctuation is not included in indexed terms. To find terms that contain Punctuation is not included in indexed terms. To find terms that contain
punctuation, such as domain names, use the asterisk as a wild card. For punctuation, such as domain names, use the asterisk as a wild card. For
@@ -168,7 +168,7 @@
\section1 Adding External Documentation \section1 Adding External Documentation
You can display external documentation in the \gui Help mode. You can display external documentation in the \uicontrol Help mode.
To augment or replace the documentation that ships with \QC and Qt: To augment or replace the documentation that ships with \QC and Qt:
\list 1 \list 1
@@ -178,8 +178,8 @@
For information on how to prepare your documentation and create a For information on how to prepare your documentation and create a
.qch file, see \l{The Qt Help Framework}. .qch file, see \l{The Qt Help Framework}.
\li To add the .qch file to \QC, select \gui Tools > \gui Options > \li To add the .qch file to \QC, select \uicontrol Tools > \uicontrol Options >
\gui Help > \gui Documentation > \gui Add. \uicontrol Help > \uicontrol Documentation > \uicontrol Add.
\endlist \endlist
@@ -190,32 +190,32 @@
space, the help opens in the full-screen help mode. space, the help opens in the full-screen help mode.
You can specify that the help always opens in full-screen mode or You can specify that the help always opens in full-screen mode or
is detached to an external window. Select \gui {Tools > Options > Help > is detached to an external window. Select \uicontrol {Tools > Options > Help >
General Settings} and specify settings for displaying context-sensitive help General Settings} and specify settings for displaying context-sensitive help
in the \gui {On context help} field. To detach the help window, select in the \uicontrol {On context help} field. To detach the help window, select
\gui {Always Show Help in External Window}. \uicontrol {Always Show Help in External Window}.
\section1 Selecting the Start Page \section1 Selecting the Start Page
You can select the page to display when you open the \gui Help mode in the You can select the page to display when you open the \uicontrol Help mode in the
\gui {Tools > Options > Help > General Settings > On help start} field. \uicontrol {Tools > Options > Help > General Settings > On help start} field.
To display the page and help panes that were open when you exited the mode, To display the page and help panes that were open when you exited the mode,
select the \gui {Show My Tabs from Last Session} option. However, Web pages select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages
are not opened, because loading them would slow down opening the \gui Help are not opened, because loading them would slow down opening the \uicontrol Help
mode. mode.
To display a particular page, select \gui {Show My Home Page}, and specify To display a particular page, select \uicontrol {Show My Home Page}, and specify
the page in the \gui {Home Page} field. the page in the \uicontrol {Home Page} field.
To display a blank page, select the \gui {Show a Blank Page} option. You can To display a blank page, select the \uicontrol {Show a Blank Page} option. You can
also select the \gui {Use Blank Page} button to set a blank page as your also select the \uicontrol {Use Blank Page} button to set a blank page as your
home page. home page.
\section1 Using Documentation Filters \section1 Using Documentation Filters
You can filter the documents displayed in the \gui Help mode to find You can filter the documents displayed in the \uicontrol Help mode to find
relevant information faster. Select from a list of filters in the relevant information faster. Select from a list of filters in the
\gui {Filtered by} field (1). The contents of the \gui Index and \gui Contents \uicontrol {Filtered by} field (1). The contents of the \uicontrol Index and \uicontrol Contents
pane in the sidebar change accordingly. pane in the sidebar change accordingly.
\image qtcreator-help-filters.png "Help filters" \image qtcreator-help-filters.png "Help filters"
@@ -231,25 +231,25 @@
\list 1 \list 1
\li Select \gui {Tools > Options > Help > Filters > Add}. \li Select \uicontrol {Tools > Options > Help > Filters > Add}.
\li Enter a name for the filter and press \gui {OK}. \li Enter a name for the filter and press \uicontrol {OK}.
\li In \gui Attributes, select the documents that you want to include \li In \uicontrol Attributes, select the documents that you want to include
in the filter. in the filter.
\image qtcreator-help-filter-attributes.png "Help filter attributes" \image qtcreator-help-filter-attributes.png "Help filter attributes"
\li Click \gui OK. \li Click \uicontrol OK.
\li In the \gui Help mode, select the filter in the \gui {Filtered by} \li In the \uicontrol Help mode, select the filter in the \uicontrol {Filtered by}
field to see the filtered documentation in the sidebar. field to see the filtered documentation in the sidebar.
\endlist \endlist
To modify filters, select a filter in \gui Filters, select the attributes, To modify filters, select a filter in \uicontrol Filters, select the attributes,
and then click \gui Apply. and then click \uicontrol Apply.
To remove filters, select them in \gui Filters, and click \gui Remove. To remove filters, select them in \uicontrol Filters, and click \uicontrol Remove.
*/ */

59
doc/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -34,9 +34,9 @@
process. process.
To view all keyboard shortcuts defined in \QC, and to change them, select To view all keyboard shortcuts defined in \QC, and to change them, select
\gui {Tools > Options > Environment > Keyboard}. The shortcuts are listed by \uicontrol {Tools > Options > Environment > Keyboard}. The shortcuts are listed by
category. To find a keyboard category. To find a keyboard
shortcut in the list, enter a function name or shortcut in the \gui Filter shortcut in the list, enter a function name or shortcut in the \uicontrol Filter
field. field.
\image qtcreator-keyboard-shortcuts.png \image qtcreator-keyboard-shortcuts.png
@@ -59,14 +59,15 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Environment > \gui Keyboard. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Environment
> \uicontrol Keyboard.
\li Select a command from the list. \li Select a command from the list.
\li In \gui{Key Sequence} enter the shortcut key you want to associate \li In \uicontrol{Key Sequence} enter the shortcut key you want to associate
with the selected command. with the selected command.
\li To revert to the default shortcut, select \gui Reset. \li To revert to the default shortcut, select \uicontrol Reset.
\endlist \endlist
@@ -74,12 +75,12 @@
\list \list
\li To import a keyboard shortcut mapping scheme, click \gui Import \li To import a keyboard shortcut mapping scheme, click \uicontrol Import
and select the .kms file containing the keyboard shortcut mapping scheme and select the .kms file containing the keyboard shortcut mapping scheme
you want to import. you want to import.
\li To export the current keyboard shortcut mapping scheme, click \li To export the current keyboard shortcut mapping scheme, click
\gui Export and select the location where you want to save the \uicontrol Export and select the location where you want to save the
exported .kms file. exported .kms file.
\endlist \endlist
@@ -159,40 +160,40 @@
\li Previous open document in history \li Previous open document in history
\li Ctrl+Tab \li Ctrl+Tab
\row \row
\li Activate \gui Locator \li Activate \uicontrol Locator
\li Ctrl+K \li Ctrl+K
\row \row
\li Switch to \gui Welcome mode \li Switch to \uicontrol Welcome mode
\li Ctrl+1 \li Ctrl+1
\row \row
\li Switch to \gui Edit mode \li Switch to \uicontrol Edit mode
\li Ctrl+2 \li Ctrl+2
\row \row
\li Switch to \gui Design mode \li Switch to \uicontrol Design mode
\li Ctrl+3 \li Ctrl+3
\row \row
\li Switch to \gui Debug mode \li Switch to \uicontrol Debug mode
\li Ctrl+4 \li Ctrl+4
\row \row
\li Switch to \gui Projects mode \li Switch to \uicontrol Projects mode
\li Ctrl+5 \li Ctrl+5
\row \row
\li Switch to \gui Analyze mode \li Switch to \uicontrol Analyze mode
\li Ctrl+6 \li Ctrl+6
\row \row
\li Switch to \gui Help mode \li Switch to \uicontrol Help mode
\li Ctrl+7 \li Ctrl+7
\row \row
\li Toggle \gui{Issues} pane \li Toggle \uicontrol{Issues} pane
\li Alt+1 (Cmd+1 on OS X) \li Alt+1 (Cmd+1 on OS X)
\row \row
\li Toggle \gui{Search Results} pane \li Toggle \uicontrol{Search Results} pane
\li Alt+2 (Cmd+2 on OS X) \li Alt+2 (Cmd+2 on OS X)
\row \row
\li Toggle \gui{Application Output} pane \li Toggle \uicontrol{Application Output} pane
\li Alt+3 (Cmd+3 on OS X) \li Alt+3 (Cmd+3 on OS X)
\row \row
\li Toggle \gui{Compile Output} pane \li Toggle \uicontrol{Compile Output} pane
\li Alt+4 (Cmd+4 on OS X) \li Alt+4 (Cmd+4 on OS X)
\row \row
\li Toggle other output panes \li Toggle other output panes
@@ -200,13 +201,13 @@
Where the number is the number of the output pane. Where the number is the number of the output pane.
\row \row
\li Activate \gui Bookmarks pane \li Activate \uicontrol Bookmarks pane
\li Alt+M \li Alt+M
\row \row
\li Activate \gui{File System} pane \li Activate \uicontrol{File System} pane
\li Alt+Y \li Alt+Y
\row \row
\li Activate \gui{Open Documents} pane \li Activate \uicontrol{Open Documents} pane
\li Alt+O \li Alt+O
\row \row
\li Maximize output panes \li Maximize output panes
@@ -218,7 +219,7 @@
\li Move to previous item in output panes \li Move to previous item in output panes
\li Shift+F6 \li Shift+F6
\row \row
\li Activate \gui Projects pane \li Activate \uicontrol Projects pane
\li Alt+X \li Alt+X
\row \row
\li Full screen \li Full screen
@@ -230,9 +231,9 @@
\li Undo \li Undo
\li Ctrl+Z \li Ctrl+Z
\row \row
\li Move to \gui Edit mode \li Move to \uicontrol Edit mode
In \gui Edit mode: In \uicontrol Edit mode:
\list \list
\li The first press moves focus to the editor \li The first press moves focus to the editor
\li The second press closes secondary windows \li The second press closes secondary windows
@@ -570,19 +571,19 @@
\li View context-sensitive help \li View context-sensitive help
\li F1 \li F1
\row \row
\li Activate contents in \gui Help mode \li Activate contents in \uicontrol Help mode
\li Ctrl+T \li Ctrl+T
\row \row
\li Add bookmark in \gui Help mode \li Add bookmark in \uicontrol Help mode
\li Ctrl+M \li Ctrl+M
\row \row
\li Activate index in \gui Help mode \li Activate index in \uicontrol Help mode
\li Ctrl+I \li Ctrl+I
\row \row
\li Reset font size \li Reset font size
\li Ctrl+0 \li Ctrl+0
\row \row
\li Activate search in \gui Help mode \li Activate search in \uicontrol Help mode
\li Ctrl+S \li Ctrl+S
\endtable \endtable

10
doc/src/howto/creator-sessions.qdoc
View File

@@ -32,7 +32,7 @@
When you exit \QC, a snapshot of your current workspace is stored as a When you exit \QC, a snapshot of your current workspace is stored as a
\e session. To restore the session automatically when you start \QC, \e session. To restore the session automatically when you start \QC,
select \gui {File > Session Manager > Restore last session on startup}. select \uicontrol {File > Session Manager > Restore last session on startup}.
When you open or create any of the following items, they automatically When you open or create any of the following items, they automatically
become a part of the session: become a part of the session:
@@ -61,17 +61,17 @@
on the first project, open the saved session. \QC opens the projects and on the first project, open the saved session. \QC opens the projects and
files that belong to the session. files that belong to the session.
To create a new session or remove existing sessions, select \gui File > To create a new session or remove existing sessions, select \uicontrol File >
\gui{Session Manager}. \uicontrol{Session Manager}.
\image qtcreator-session-manager.png \image qtcreator-session-manager.png
To switch between sessions, choose \gui {File > Session Manager}. If you do To switch between sessions, choose \uicontrol {File > Session Manager}. If you do
not create or select a session, \QC always uses the default session, which not create or select a session, \QC always uses the default session, which
was created the last time you exited \QC. was created the last time you exited \QC.
When you launch \QC, a list of existing sessions is displayed in the When you launch \QC, a list of existing sessions is displayed in the
\gui Welcome mode. \uicontrol Welcome mode.
\image qtcreator-welcome-session.png \image qtcreator-welcome-session.png

10
doc/src/howto/creator-task-lists.qdoc
View File

@@ -32,7 +32,7 @@
You can use code scanning and analysis tools to examine source code. These You can use code scanning and analysis tools to examine source code. These
tools report issues for you to fix. \QC enables you to load lists of tools report issues for you to fix. \QC enables you to load lists of
issues into the \gui Issues pane for easier navigation. issues into the \uicontrol Issues pane for easier navigation.
\QC expects tasks to be defined in a simple line-based file format that is \QC expects tasks to be defined in a simple line-based file format that is
easy to generate using scripts. The scripts can either convert reports from easy to generate using scripts. The scripts can either convert reports from
@@ -43,14 +43,14 @@
\section1 Managing Task List Entries \section1 Managing Task List Entries
To open task list files in the \gui Issues pane, choose \gui File > To open task list files in the \uicontrol Issues pane, choose \uicontrol File >
\gui Open. Right-click a task list entry to open a context menu that \uicontrol Open. Right-click a task list entry to open a context menu that
contains commands for managing the entry. You can copy or remove task list contains commands for managing the entry. You can copy or remove task list
entries or navigate to the corresponding source code. entries or navigate to the corresponding source code.
\QC monitors the loaded files and displays the changes in the \gui Issues \QC monitors the loaded files and displays the changes in the \uicontrol Issues
pane. To keep the current entries in a task list, but stop checking for pane. To keep the current entries in a task list, but stop checking for
changes, select \gui {Stop Monitoring}. changes, select \uicontrol {Stop Monitoring}.
\section1 Task List File Format \section1 Task List File Format

77
doc/src/howto/creator-tips.qdoc
View File

@@ -37,13 +37,13 @@
\list \list
\li \gui Welcome mode \key Ctrl+1 \li \uicontrol Welcome mode \key Ctrl+1
\li \gui Edit mode \key Ctrl+2 \li \uicontrol Edit mode \key Ctrl+2
\li \gui Design mode \key Ctrl+3 \li \uicontrol Design mode \key Ctrl+3
\li \gui Debug mode \key Ctrl+4 \li \uicontrol Debug mode \key Ctrl+4
\li \gui Projects mode \key Ctrl+5 \li \uicontrol Projects mode \key Ctrl+5
\li \gui Analyze mode \key Ctrl+6 \li \uicontrol Analyze mode \key Ctrl+6
\li \gui Help mode \key Ctrl+7 \li \uicontrol Help mode \key Ctrl+7
\endlist \endlist
@@ -56,16 +56,16 @@
To move forward in the location history, press \key {Alt+Right} To move forward in the location history, press \key {Alt+Right}
(\key {Cmd+Opt+Right} on OS X). To move backward, press \key {Alt+Left} (\key {Cmd+Opt+Right} on OS X). To move backward, press \key {Alt+Left}
(\key {Cmd+Opt+Left} on OS X). For example, if you use the \gui Locator (\key {Cmd+Opt+Left} on OS X). For example, if you use the \uicontrol Locator
to jump to a symbol in the same file, you can jump back to your original to jump to a symbol in the same file, you can jump back to your original
location in that file by pressing \key {Alt+Left}. location in that file by pressing \key {Alt+Left}.
\section1 Moving To the Edit Mode \section1 Moving To the Edit Mode
To move to the \gui Edit mode and currently active file, press To move to the \uicontrol Edit mode and currently active file, press
\key Esc. \key Esc.
If you already are in the \gui Edit mode: If you already are in the \uicontrol Edit mode:
\list \list
@@ -77,8 +77,8 @@
\section1 Using the Filter in Options Dialog \section1 Using the Filter in Options Dialog
To find specific settings you require in \gui{Tools} > \gui{Options} To find specific settings you require in \uicontrol{Tools} > \uicontrol{Options}
use the filter located at the top left of the \gui Options dialog box. use the filter located at the top left of the \uicontrol Options dialog box.
\section1 Opening Output Panes \section1 Opening Output Panes
@@ -90,18 +90,18 @@
\list \list
\li \gui{Issues} pane Alt+1 (Cmd+1 on OS X) \li \uicontrol{Issues} pane Alt+1 (Cmd+1 on OS X)
\li \gui{Search Results} pane Alt+2 (Cmd+2 on OS X) \li \uicontrol{Search Results} pane Alt+2 (Cmd+2 on OS X)
\li \gui{Application Output} pane Alt+3 (Cmd+3 on OS X) \li \uicontrol{Application Output} pane Alt+3 (Cmd+3 on OS X)
\li \gui{Compile Output} pane Alt+4 (Cmd+4 on OS X) \li \uicontrol{Compile Output} pane Alt+4 (Cmd+4 on OS X)
\endlist \endlist
To open the other output panes, such as \gui{General Messages} and To open the other output panes, such as \uicontrol{General Messages} and
\gui{Version Control}, select \gui Window > \gui {Output Panes}. The menu \uicontrol{Version Control}, select \uicontrol Window > \uicontrol {Output Panes}. The menu
items also display the keyboard shortcuts that you can use. items also display the keyboard shortcuts that you can use.
For more information about output panes, see \l{Viewing Output}. For more information about output panes, see \l{Viewing Output}.
@@ -112,8 +112,8 @@
You can see the keyboard shortcut for a menu command in the menu You can see the keyboard shortcut for a menu command in the menu
or the tooltip for a button. or the tooltip for a button.
To customize, import or export keyboard shortcuts, select \gui Tools > To customize, import or export keyboard shortcuts, select \uicontrol Tools >
\gui Options > \gui Environment > \gui Keyboard. \uicontrol Options > \uicontrol Environment > \uicontrol Keyboard.
\section1 Running \QC From Command Line \section1 Running \QC From Command Line
@@ -128,7 +128,7 @@
\section1 Showing and Hiding the Sidebar \section1 Showing and Hiding the Sidebar
To toggle the sidebar in the \gui Edit and \gui Debug modes, click To toggle the sidebar in the \uicontrol Edit and \uicontrol Debug modes, click
\inlineimage qtcreator-togglebutton.png \inlineimage qtcreator-togglebutton.png
or press \key Alt+0 (\key Cmd+0 on OS X). or press \key Alt+0 (\key Cmd+0 on OS X).
@@ -138,11 +138,11 @@
\section1 Moving To Symbols \section1 Moving To Symbols
To move straight to a symbol used in a project, select the symbol in the To move straight to a symbol used in a project, select the symbol in the
\gui Editor toolbar drop-down menu. For more information on the editor \uicontrol Editor toolbar drop-down menu. For more information on the editor
toolbar, see \l {Using the Editor Toolbar}. toolbar, see \l {Using the Editor Toolbar}.
To jump to a symbol in the current file, press \key {Ctrl+K} to open the To jump to a symbol in the current file, press \key {Ctrl+K} to open the
\gui Locator, enter a period (.), and start typing the symbol name. Then \uicontrol Locator, enter a period (.), and start typing the symbol name. Then
select the symbol in the list. For more information on using the locator, select the symbol in the list. For more information on using the locator,
see \l{Searching with the Locator}. see \l{Searching with the Locator}.
@@ -155,15 +155,15 @@
If an instance of a class is derived from QObject, and you would like to If an instance of a class is derived from QObject, and you would like to
find all other objects connected to one of your object's slots using find all other objects connected to one of your object's slots using
Qt's signals and slots mechanism, select \gui Tools > \gui Options Qt's signals and slots mechanism, select \uicontrol Tools > \uicontrol Options
> \gui{Debugger} > \gui{Locals and Expressions} > > \uicontrol{Debugger} > \uicontrol{Locals and Expressions} >
\gui{Use Debugging Helper}. \uicontrol{Use Debugging Helper}.
In the \gui{Locals and Expressions} view, expand the object's entry and open In the \uicontrol{Locals and Expressions} view, expand the object's entry and open
the slot in the \e slots subitem. The objects connected to this slot are the slot in the \e slots subitem. The objects connected to this slot are
shown as children of the slot. This method works with signals too. shown as children of the slot. This method works with signals too.
For more information about the \gui{Locals and Expressions} view, see For more information about the \uicontrol{Locals and Expressions} view, see
\l{Locals and Expressions}. \l{Locals and Expressions}.
\section1 Displaying Low Level Data \section1 Displaying Low Level Data
@@ -175,10 +175,10 @@
To switch off the debugging helpers: To switch off the debugging helpers:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger >
\gui{Locals and Expressions}. \uicontrol{Locals and Expressions}.
\li Uncheck the \gui{Use Debugging Helper} checkbox. \li Uncheck the \uicontrol{Use Debugging Helper} checkbox.
\endlist \endlist
@@ -189,39 +189,40 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Debugger > \gui General. \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Debugger > \uicontrol General.
\li Select the \gui {Use tooltips in main editor while debugging} check \li Select the \uicontrol {Use tooltips in main editor while debugging} check
box. box.
\endlist \endlist
When you hover over a variable in the code editor in \gui Debug mode, a When you hover over a variable in the code editor in \uicontrol Debug mode, a
tooltip is displayed. To keep the tooltip visible, click the pin button. tooltip is displayed. To keep the tooltip visible, click the pin button.
You can expand pinned tooltips to view their full content. You can expand pinned tooltips to view their full content.
\image qtcreator-pin-tooltip.png \image qtcreator-pin-tooltip.png
Pinned tooltips are stored in the session. To close all pinned tooltips, Pinned tooltips are stored in the session. To close all pinned tooltips,
select \gui {Close Editor Tooltips} in the context menu in the \gui {Locals select \uicontrol {Close Editor Tooltips} in the context menu in the \uicontrol {Locals
and Expressions} view. and Expressions} view.
\section1 Locating Files \section1 Locating Files
The \gui Locator provides one of the easiest ways in \QC to browse The \uicontrol Locator provides one of the easiest ways in \QC to browse
through projects, files, classes, functions, documentation and file systems. through projects, files, classes, functions, documentation and file systems.
To quickly access files not directly mentioned in your project, you can To quickly access files not directly mentioned in your project, you can
create your own locator filters. That way you can locate files in a create your own locator filters. That way you can locate files in a
directory structure you have defined. directory structure you have defined.
To create locator filters, select \gui {Tools > Options > Locator > Add}. To create locator filters, select \uicontrol {Tools > Options > Locator > Add}.
For more information, see \l{Creating Locator Filters}. For more information, see \l{Creating Locator Filters}.
\section1 Adding a License Header Template for C++ Code \section1 Adding a License Header Template for C++ Code
A file containing a license header for C++ can be specified under A file containing a license header for C++ can be specified under
\gui{Tools > Options > C++ > License Template}. It may contain special \uicontrol{Tools > Options > C++ > License Template}. It may contain special
placeholders enclosed in \c{%%} that are replaced when generating a placeholders enclosed in \c{%%} that are replaced when generating a
new file: new file:

186
doc/src/howto/creator-ui.qdoc
View File

@@ -30,7 +30,7 @@
\title User Interface \title User Interface
When you start \QC, it opens to the \gui Welcome mode, where you can: When you start \QC, it opens to the \uicontrol Welcome mode, where you can:
\list \list
@@ -65,10 +65,10 @@
{corresponding keyboard shortcut}. {corresponding keyboard shortcut}.
To hide the mode selector and to save space on the display, select To hide the mode selector and to save space on the display, select
\gui Window > \gui {Show Mode Selector}. \uicontrol Window > \uicontrol {Show Mode Selector}.
The following image displays an example application in \gui Edit mode (1) The following image displays an example application in \uicontrol Edit mode (1)
and \gui Design mode (2). and \uicontrol Design mode (2).
\image qtcreator-qt-quick-editors.png "Edit mode and Design mode" \image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
@@ -76,37 +76,37 @@
\list \list
\li \gui Welcome mode for opening projects. \li \uicontrol Welcome mode for opening projects.
\li \gui{\l{Coding}{Edit}} mode for editing project and source \li \uicontrol{\l{Coding}{Edit}} mode for editing project and source
files. files.
\li \gui{\l{Designing User Interfaces}{Design}} mode for designing and \li \uicontrol{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for developing application user interfaces. This mode is available for
UI files. UI files.
\li \gui{\l{Debugging}{Debug}} mode for inspecting the state of your \li \uicontrol{\l{Debugging}{Debug}} mode for inspecting the state of your
application while debugging. application while debugging.
\li \gui{\l{Specifying Build Settings}{Projects}} mode for configuring \li \uicontrol{\l{Specifying Build Settings}{Projects}} mode for configuring
project building and execution. This mode is available when a project building and execution. This mode is available when a
project is open. project is open.
\li \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools \li \uicontrol{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
to detect memory leaks and profile C++ or QML code. to detect memory leaks and profile C++ or QML code.
\li \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation. \li \uicontrol{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist \endlist
Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} > Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} >
\gui {Start Debugging} > \gui {Start Debugging} automatically switches to \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to
\gui {Debug} mode. \uicontrol {Debug} mode.
\section1 Browsing Project Contents \section1 Browsing Project Contents
The sidebar is available in the \gui Edit and \gui Debug modes, and with a The sidebar is available in the \uicontrol Edit and \uicontrol Debug modes, and with a
different set of views in the \gui Design mode. Use the different set of views in the \uicontrol Design mode. Use the
sidebar to browse projects, files, and bookmarks, and to view the class sidebar to browse projects, files, and bookmarks, and to view the class
hierarchy. hierarchy.
@@ -116,25 +116,25 @@
\list \list
\li \gui Projects shows a list of projects open in the current \li \uicontrol Projects shows a list of projects open in the current
session. session.
\li \gui{Open Documents} shows currently open files. \li \uicontrol{Open Documents} shows currently open files.
\li \gui Bookmarks shows all bookmarks for the current session. \li \uicontrol Bookmarks shows all bookmarks for the current session.
\li \gui{File System} shows all files in the currently selected \li \uicontrol{File System} shows all files in the currently selected
directory. directory.
\li \gui {Class View} shows the class hierarchy of the currently \li \uicontrol {Class View} shows the class hierarchy of the currently
open projects. open projects.
\li \gui Outline shows the symbol hierarchy of a C++ file and the type \li \uicontrol Outline shows the symbol hierarchy of a C++ file and the type
hierarchy of a QML file. hierarchy of a QML file.
\li \gui {Type Hierarchy} shows the base classes of a class. \li \uicontrol {Type Hierarchy} shows the base classes of a class.
\li \gui {Include Hierarchy} shows which files are included in the current file \li \uicontrol {Include Hierarchy} shows which files are included in the current file
and which files include the current file. and which files include the current file.
\endlist \endlist
@@ -147,15 +147,15 @@
\list \list
\li To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png \li To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
(\gui {Hide Sidebar/Show Sidebar}) or press \key Alt+0 (\uicontrol {Hide Sidebar/Show Sidebar}) or press \key Alt+0
(\key Cmd+0 on OS X). (\key Cmd+0 on OS X).
\li To split the sidebar, click \inlineimage qtcreator-splitbar.png \li To split the sidebar, click \inlineimage qtcreator-splitbar.png
(\gui {Split}). Select new content to view in the split view. (\uicontrol {Split}). Select new content to view in the split view.
\li To close a sidebar view, click \li To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png \inlineimage qtcreator-closesidebar.png
(\gui {Close}). (\uicontrol {Close}).
\endlist \endlist
@@ -188,15 +188,15 @@
\li To hide the categories and sort project files alphabetically, click \li To hide the categories and sort project files alphabetically, click
\inlineimage qtcreator-filter.png \inlineimage qtcreator-filter.png
(\gui {Filter Tree}) and select \gui{Simplify Tree}. (\uicontrol {Filter Tree}) and select \uicontrol{Simplify Tree}.
\li To hide source files which are automatically generated by the build \li To hide source files which are automatically generated by the build
system, select \gui {Filter Tree > Hide Generated Files}. system, select \uicontrol {Filter Tree > Hide Generated Files}.
\li To keep the position in the project tree synchronized with the file \li To keep the position in the project tree synchronized with the file
currently opened in the editor, click currently opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png \inlineimage qtcreator-synchronizefocus.png
(\gui {Synchronize with Editor}). (\uicontrol {Synchronize with Editor}).
\li To see the absolute path of a file, move the mouse pointer over the \li To see the absolute path of a file, move the mouse pointer over the
file name. file name.
@@ -206,51 +206,51 @@
Files that are not sources or data can be still included into a project's Files that are not sources or data can be still included into a project's
distribution tarball by adding their paths to the \c DISTFILES variable in distribution tarball by adding their paths to the \c DISTFILES variable in
the .pro file. This way they also become known to \QC, so that they are the .pro file. This way they also become known to \QC, so that they are
visible in the \gui Projects view and are known to the locator and search. visible in the \uicontrol Projects view and are known to the locator and search.
\section2 Viewing the File System \section2 Viewing the File System
If you cannot see a file in the \gui Projects view, switch to the If you cannot see a file in the \uicontrol Projects view, switch to the
\gui {File System} view, which shows all the files in the file system. \uicontrol {File System} view, which shows all the files in the file system.
To also show hidden files, select \gui {Filter Files} > \gui {Show Hidden Files}. To also show hidden files, select \uicontrol {Filter Files} > \uicontrol {Show Hidden Files}.
To keep the position in the tree synchronized with the file To keep the position in the tree synchronized with the file
opened in the editor, select \gui {Synchronize with Editor}. opened in the editor, select \uicontrol {Synchronize with Editor}.
\section2 Viewing the Class Hierarchy \section2 Viewing the Class Hierarchy
The \gui {Class View} shows the class hierarchy of the currently The \uicontrol {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png \inlineimage qtcreator-show-subprojects.png
(\gui {Show Subprojects}). (\uicontrol {Show Subprojects}).
To visit all parts of a namespace, double-click on the namespace item To visit all parts of a namespace, double-click on the namespace item
multiple times. multiple times.
\section2 Viewing QML Types \section2 Viewing QML Types
The \gui Outline view shows the type hierarchy in a QML file. The \uicontrol Outline view shows the type hierarchy in a QML file.
\list \list
\li To see a complete list of all bindings, select \gui {Filter Tree > \li To see a complete list of all bindings, select \uicontrol {Filter Tree >
Show All Bindings}. Show All Bindings}.
\li To keep the position in the view synchronized with the QML type \li To keep the position in the view synchronized with the QML type
selected in the editor, select \gui {Synchronize with Editor}. selected in the editor, select \uicontrol {Synchronize with Editor}.
\endlist \endlist
\section2 Viewing Type Hierarchy \section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select To view the base classes of a class, right-click the class and select
\gui {Open Type Hierarchy} or press \key {Ctrl+Shift+T}. \uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
\section2 Viewing Include Hierarchy \section2 Viewing Include Hierarchy
To view which files are included in the current file and which files include To view which files are included in the current file and which files include
the current file, right-click in the editor and select \gui {Open Include Hierarchy} the current file, right-click in the editor and select \uicontrol {Open Include Hierarchy}
or press \key {Ctrl+Shift+I}. or press \key {Ctrl+Shift+I}.
\section1 Viewing Output \section1 Viewing Output
@@ -259,73 +259,73 @@
\list \list
\li \gui{Issues} \li \uicontrol{Issues}
\li \gui{Search Results} \li \uicontrol{Search Results}
\li \gui{Application Output} \li \uicontrol{Application Output}
\li \gui{Compile Output} \li \uicontrol{Compile Output}
\li \gui {QML/JS Console} \li \uicontrol {QML/JS Console}
\li \gui {To-Do Entries} \li \uicontrol {To-Do Entries}
\li \gui{Version Control} \li \uicontrol{Version Control}
\li \gui{General Messages} \li \uicontrol{General Messages}
\endlist \endlist
Output panes are available in all \l{Modes}{modes}. Click the name of an Output panes are available in all \l{Modes}{modes}. Click the name of an
output pane to open the pane. To maximize an open output pane, click the output pane to open the pane. To maximize an open output pane, click the
\gui {Maximize Output Pane} button or press \key {Alt+9}. \uicontrol {Maximize Output Pane} button or press \key {Alt+9}.
To search within the \gui{Application Output} and \gui{Compile Output} To search within the \uicontrol{Application Output} and \uicontrol{Compile Output}
panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in
the \gui Find field and click the left and right arrows to search down and the \uicontrol Find field and click the left and right arrows to search down and
up in the pane. up in the pane.
To open the \gui{General Messages} and \l{Using Version Control Systems} To open the \uicontrol{General Messages} and \l{Using Version Control Systems}
{Version Control} panes, select {Version Control} panes, select
\gui {Window > Output Panes}. To display the \gui {To-Do Entries} pane, \uicontrol {Window > Output Panes}. To display the \uicontrol {To-Do Entries} pane,
enable the Todo plugin. enable the Todo plugin.
\section2 Issues \section2 Issues
The \gui{Issues} pane provides lists of following types of issues: The \uicontrol{Issues} pane provides lists of following types of issues:
\list \list
\li \gui Analyzer - Errors encountered while running the \li \uicontrol Analyzer - Errors encountered while running the
\l{Analyzing Code}{Valgrind code analysis tools}. \l{Analyzing Code}{Valgrind code analysis tools}.
\li \gui {Bar Descriptor} - Errors and warnings encountered when using \li \uicontrol {Bar Descriptor} - Errors and warnings encountered when using
the BlackBerry 10 BAR descriptor editor to customize the appearance the BlackBerry 10 BAR descriptor editor to customize the appearance
and behavior of an application. and behavior of an application.
\li \gui {Build System} - Errors and warnings encountered during a \li \uicontrol {Build System} - Errors and warnings encountered during a
build. build.
\li \gui Compile - Selected output from the compiler. Open the \li \uicontrol Compile - Selected output from the compiler. Open the
\gui {Compile Output} pane for more detailed information. \uicontrol {Compile Output} pane for more detailed information.
\li \gui{Debug Information} - Lists debug information packages that might \li \uicontrol{Debug Information} - Lists debug information packages that might
be missing. be missing.
\li \gui{Debugger Runtime} - Errors encountered when starting \QC. For \li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For
example, information about missing DLLs. example, information about missing DLLs.
\li \gui Deployment - Errors encountered between building an application \li \uicontrol Deployment - Errors encountered between building an application
successfully and starting it on a device. successfully and starting it on a device.
\li \gui {My Tasks} - Entries from a task list file (.tasks) generated \li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated
by \l{Showing Task List Files in Issues Pane} by \l{Showing Task List Files in Issues Pane}
{code scanning and analysis tools}. {code scanning and analysis tools}.
\li \gui QML - Errors in QML syntax. \li \uicontrol QML - Errors in QML syntax.
\li \gui {QML Analysis} - Results of the JavaScript \li \uicontrol {QML Analysis} - Results of the JavaScript
\l{Checking JavaScript and QML Syntax} \l{Checking JavaScript and QML Syntax}
{code syntax and validation checks} {code syntax and validation checks}
@@ -333,7 +333,7 @@
The pane filters out irrelevant output from the build tools and presents the The pane filters out irrelevant output from the build tools and presents the
issues in an organized way. To further filter the output by type, select issues in an organized way. To further filter the output by type, select
\gui {Filter Tree} \uicontrol {Filter Tree}
and then select a filter. and then select a filter.
\image qtcreator-build-issues.png \image qtcreator-build-issues.png
@@ -345,18 +345,18 @@
annotation view of the line that causes the error message. annotation view of the line that causes the error message.
To navigate to the corresponding source code, click an issue or To navigate to the corresponding source code, click an issue or
select \gui {Show in Editor} in the context menu. The entry must contain the select \uicontrol {Show in Editor} in the context menu. The entry must contain the
name of the file where the issue was found. name of the file where the issue was found.
To view more information about an issue in the \gui {Compile Output} pane, To view more information about an issue in the \uicontrol {Compile Output} pane,
select \gui {Show Output} in the context menu. select \uicontrol {Show Output} in the context menu.
To jump from one issue to the next or previous one, press \key F6 and To jump from one issue to the next or previous one, press \key F6 and
\key Shift+F6. \key Shift+F6.
\section2 Search Results \section2 Search Results
In the \gui{Search Results} pane, you can search through projects, files on In the \uicontrol{Search Results} pane, you can search through projects, files on
a file system or the currently open file: a file system or the currently open file:
\image qtcreator-search-results.png "Search Results output pane" \image qtcreator-search-results.png "Search Results output pane"
@@ -371,7 +371,7 @@
\section2 Application Output \section2 Application Output
The \gui{Application Output} pane displays the status of a program when The \uicontrol{Application Output} pane displays the status of a program when
it is executed, and the debug output. it is executed, and the debug output.
\image qtcreator-application-output.png \image qtcreator-application-output.png
@@ -381,20 +381,20 @@
\section2 Compile Output \section2 Compile Output
The \gui{Compile Output} pane provides all output from the compiler. The \uicontrol{Compile Output} pane provides all output from the compiler.
The \gui{Compile Output} is a more detailed version of information The \uicontrol{Compile Output} is a more detailed version of information
displayed in the \gui{Issues} pane. displayed in the \uicontrol{Issues} pane.
\image qtcreator-compile-pane.png \image qtcreator-compile-pane.png
Double-click on a file name in an error message to open the file in the Double-click on a file name in an error message to open the file in the
code editor. code editor.
Select the \gui {Cancel Build} button to cancel the build. Select the \uicontrol {Cancel Build} button to cancel the build.
\section2 QML/JS Console \section2 QML/JS Console
In the \gui {QML/JS Console}, you can type JavaScript expressions and use them to get In the \uicontrol {QML/JS Console}, you can type JavaScript expressions and use them to get
information about the state of your application during debugging. You can change property information about the state of your application during debugging. You can change property
values temporarily, without editing the source, and view the results in the running values temporarily, without editing the source, and view the results in the running
application. application.
@@ -405,33 +405,35 @@
\section2 To-Do List \section2 To-Do List
The \gui {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and The \uicontrol {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and
WARNING keywords from the current file or from all project files. The WARNING keywords from the current file or from all project files. The
keywords are organized into information, warning, and error categories. keywords are organized into information, warning, and error categories.
\image qtcreator-todo-pane.png \image qtcreator-todo-pane.png
To add keywords, select \gui Tools > \gui Options > \gui {To-Do} > \gui Add. To add keywords, select \uicontrol Tools > \uicontrol Options >
\uicontrol {To-Do} > \uicontrol Add.
Set an icon and a line background color for the keyword. To change the icons Set an icon and a line background color for the keyword. To change the icons
and colors set for an existing keyword, select \gui Edit. and colors set for an existing keyword, select \uicontrol Edit.
To determine whether the keywords in the whole project or in the current To determine whether the keywords in the whole project or in the current
file are displayed by default, select \gui {Scanning scope}. file are displayed by default, select \uicontrol {Scanning scope}.
The Todo plugin is disabled by default. To enable the plugin, select The Todo plugin is disabled by default. To enable the plugin, select
\gui Help > \gui {About Plugins} > \gui Utilities > \gui Todo and restart \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol Todo and restart
\QC. \QC.
In addition, you can open task list files generated by code scanning and In addition, you can open task list files generated by code scanning and
analysis tools in the \gui Issues pane. For more information, see analysis tools in the \uicontrol Issues pane. For more information, see
\l{Showing Task List Files in Issues Pane}. \l{Showing Task List Files in Issues Pane}.
\section1 Changing Languages \section1 Changing Languages
\QC has been localized into several languages. If the system language is one \QC has been localized into several languages. If the system language is one
of the supported languages, it is automatically selected. To change the of the supported languages, it is automatically selected. To change the
language, select \gui {Tools > Options > Environment} and select a language language, select \uicontrol {Tools > Options > Environment} and select a language
in the \gui Language field. The change takes effect after you restart \QC. in the \uicontrol Language field. The change takes effect after you restart \QC.
\section1 Viewing Images \section1 Viewing Images
@@ -482,15 +484,15 @@
\li For \li For
\li Look In \li Look In
\row \row
\li \gui Tools > \gui Options \li \uicontrol Tools > \uicontrol Options
\li \gui {Qt Creator} > \gui Preferences \li \uicontrol {Qt Creator} > \uicontrol Preferences
\row \row
\li \gui Help > \gui {About Plugins} \li \uicontrol Help > \uicontrol {About Plugins}
\li \gui {Qt Creator} > \gui {About Plugins} \li \uicontrol {Qt Creator} > \uicontrol {About Plugins}
\row \row
\li Keyboard shortcuts \li Keyboard shortcuts
\li \gui {Qt Creator} > \gui Preferences > \gui Environment > \li \uicontrol {Qt Creator} > \uicontrol Preferences > \uicontrol Environment >
\gui Keyboard \uicontrol Keyboard
\endtable \endtable
*/ */

309
doc/src/howto/creator-vcs.qdoc
View File

@@ -73,8 +73,8 @@
\QC uses the version control system's command line clients to access your \QC uses the version control system's command line clients to access your
repositories. To allow access, make sure that the command line clients can repositories. To allow access, make sure that the command line clients can
be located using the \c{PATH} environment variable or specify the path to be located using the \c{PATH} environment variable or specify the path to
the command line client executables in \gui{Tools} > \gui{Options} > the command line client executables in \uicontrol{Tools} > \uicontrol{Options} >
\gui {Version Control}. \uicontrol {Version Control}.
After you set up the version control system, use the command line to check After you set up the version control system, use the command line to check
that everything works (for example, use the status command). If no issues that everything works (for example, use the status command). If no issues
@@ -90,26 +90,27 @@
you run Git from a Windows command prompt, it looks for the SSH keys in its you run Git from a Windows command prompt, it looks for the SSH keys in its
installation directory, and therefore, the authorization fails. installation directory, and therefore, the authorization fails.
You can set the \c HOME environment variable from \QC. Select \gui {Tools > You can set the \c HOME environment variable from \QC. Select \uicontrol {Tools >
Options > Version Control > Git}. Select the \gui {Environment Variables} Options > Version Control > Git}. Select the \uicontrol {Environment Variables}
and the \gui {Set "HOME" environment variable} check boxes. \c HOME is set and the \uicontrol {Set "HOME" environment variable} check boxes. \c HOME is set
to \c %HOMEDRIVE%%HOMEPATH% when the Git executable is run and authorization to \c %HOMEDRIVE%%HOMEPATH% when the Git executable is run and authorization
works as it would with \c {git bash}. works as it would with \c {git bash}.
\section1 Setting Up General Options \section1 Setting Up General Options
Select \gui{Tools} > \gui{Options} > \gui{Version Control} > \gui{General} Select \uicontrol{Tools} > \uicontrol{Options} > \uicontrol{Version Control}
> \uicontrol{General}
to specify settings for submit messages: to specify settings for submit messages:
\list \list
\li \gui{Submit message check script} is a script or program that \li \uicontrol{Submit message check script} is a script or program that
can be used to perform checks on the submit message before can be used to perform checks on the submit message before
submitting. The submit message is passed in as the script's first submitting. The submit message is passed in as the script's first
parameter. If there is an error, the script should output a parameter. If there is an error, the script should output a
message on standard error and return a non-zero exit code. message on standard error and return a non-zero exit code.
\li \gui{User/alias configuration file} is a text file that lists \li \uicontrol{User/alias configuration file} is a text file that lists
author names in mailmap format. For each author, you must specify a author names in mailmap format. For each author, you must specify a
real name and email address and optionally an alias and a second real name and email address and optionally an alias and a second
email address. For example: email address. For example:
@@ -120,9 +121,9 @@
\endcode \endcode
After you specify a file in this field, you can select authors After you specify a file in this field, you can select authors
as values of the submit message fields in the \gui Nicknames dialog. as values of the submit message fields in the \uicontrol Nicknames dialog.
\li \gui{User fields configuration file} is a simple text file \li \uicontrol{User fields configuration file} is a simple text file
consisting of lines specifying submit message fields that take consisting of lines specifying submit message fields that take
authors as values, for example: authors as values, for example:
@@ -137,17 +138,17 @@
After you specify a file in this field, you can add authors as After you specify a file in this field, you can add authors as
values of the submit message fields when submitting changes. If values of the submit message fields when submitting changes. If
you also specified a \gui{User/alias configuration file}, you can you also specified a \uicontrol{User/alias configuration file}, you can
select authors in the \gui Nicknames dialog. select authors in the \uicontrol Nicknames dialog.
\li \gui{SSH prompt command} specifies an ssh-askpass command that you \li \uicontrol{SSH prompt command} specifies an ssh-askpass command that you
can use (on Linux) to prompt the user for a password when using SSH. can use (on Linux) to prompt the user for a password when using SSH.
For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the
ssh-askpass implementation that you use. ssh-askpass implementation that you use.
\li \gui {Patch command} specifies the path to the patch utility that is \li \uicontrol {Patch command} specifies the path to the patch utility that is
used to apply changes in the format used to represent the diff used to apply changes in the format used to represent the diff
output. The \gui Revert command uses the patch utility to revert output. The \uicontrol Revert command uses the patch utility to revert
partial changes. partial changes.
\endlist \endlist
@@ -156,24 +157,24 @@
\QC allows you to create repositories for version control systems that \QC allows you to create repositories for version control systems that
support local repository creation, such as Git, Mercurial, or Bazaar. support local repository creation, such as Git, Mercurial, or Bazaar.
When creating a new project by selecting \gui File > \gui{New File or When creating a new project by selecting \uicontrol File > \uicontrol{New File or
Project}, you can choose a version control system on the final wizard page. Project}, you can choose a version control system on the final wizard page.
You can also select \gui Tools and then select \gui {Create Repository} You can also select \uicontrol Tools and then select \uicontrol {Create Repository}
in the submenu for the version control system. in the submenu for the version control system.
To import a project that is under version control, choose \gui {File > To import a project that is under version control, choose \uicontrol {File >
New File or Project > Project from Version Control} and select the New File or Project > Project from Version Control} and select the
version control system that you use. Follow the instructions of the version control system that you use. Follow the instructions of the
wizard to import the project. wizard to import the project.
\section1 Using Version Control Systems \section1 Using Version Control Systems
The \gui{Tools} menu contains a submenu for each supported version The \uicontrol{Tools} menu contains a submenu for each supported version
control system. control system.
The \gui{Version Control} output pane displays the commands that are The \uicontrol{Version Control} output pane displays the commands that are
executed, a timestamp, and the relevant output. Select \gui {Window > Output executed, a timestamp, and the relevant output. Select \uicontrol {Window > Output
Panes > Version Control} to open the pane. Panes > Version Control} to open the pane.
\image qtcreator-vcs-pane.png \image qtcreator-vcs-pane.png
@@ -203,14 +204,14 @@
With Git, the diff is displayed side-by-side in a \l{Comparing Files} With Git, the diff is displayed side-by-side in a \l{Comparing Files}
{diff editor} by default. To use the inline diff view instead, select the {diff editor} by default. To use the inline diff view instead, select the
\gui {Switch to Text Diff Editor} option from the toolbar. In the inline \uicontrol {Switch to Text Diff Editor} option from the toolbar. In the inline
diff view, you can use context menu commands to apply, revert, stage, and diff view, you can use context menu commands to apply, revert, stage, and
unstage hunks, as well as send them to a code pasting service. unstage hunks, as well as send them to a code pasting service.
\section2 Viewing Versioning History and Change Details \section2 Viewing Versioning History and Change Details
Display the versioning history of a file by selecting \gui{Log} Display the versioning history of a file by selecting \uicontrol{Log}
or \gui{Filelog}. Typically, the log output contains the date, the commit or \uicontrol{Filelog}. Typically, the log output contains the date, the commit
message, and a change or revision identifier. Click on the identifier to message, and a change or revision identifier. Click on the identifier to
display a description of the change including the diff. display a description of the change including the diff.
Right-clicking on an identifier brings up a context menu that lets you Right-clicking on an identifier brings up a context menu that lets you
@@ -221,8 +222,8 @@
\section2 Annotating Files \section2 Annotating Files
Annotation views are obtained by selecting \gui{Annotate} or \gui{Blame}. Annotation views are obtained by selecting \uicontrol{Annotate} or \uicontrol{Blame}.
Selecting \gui{Annotate} or \gui{Blame} displays the lines of the file Selecting \uicontrol{Annotate} or \uicontrol{Blame} displays the lines of the file
prepended by the change identifier they originate from. Clicking on the prepended by the change identifier they originate from. Clicking on the
change identifier shows a detailed description of the change. change identifier shows a detailed description of the change.
@@ -238,19 +239,19 @@
\section2 Committing Changes \section2 Committing Changes
Once you have finished making changes, submit them to the version control Once you have finished making changes, submit them to the version control
system by choosing \gui{Commit} or \gui{Submit}. \QC displays a system by choosing \uicontrol{Commit} or \uicontrol{Submit}. \QC displays a
commit page containing a text editor where you can enter your commit commit page containing a text editor where you can enter your commit
message and a checkable list of modified files to be included. message and a checkable list of modified files to be included.
\image qtcreator-vcs-commit.png \image qtcreator-vcs-commit.png
When you have finished filling out the commit page information, click on When you have finished filling out the commit page information, click on
\gui{Commit} to start committing. \uicontrol{Commit} to start committing.
The \gui{Diff Selected Files} button brings up a diff view of the The \uicontrol{Diff Selected Files} button brings up a diff view of the
files selected in the file list. Since the commit page is just another files selected in the file list. Since the commit page is just another
editor, you can go back to it by closing the diff view. You can also switch editor, you can go back to it by closing the diff view. You can also switch
to an open diff view by selecting it in the \gui{Open Documents} pane in the to an open diff view by selecting it in the \uicontrol{Open Documents} pane in the
sidebar. sidebar.
\section2 Reverting Changes \section2 Reverting Changes
@@ -260,7 +261,7 @@
The changes discarded depend on the version control system. The changes discarded depend on the version control system.
A version control system can replace the \gui Revert menu option with other A version control system can replace the \uicontrol Revert menu option with other
options. options.
\section3 Reverting Changes Using Git \section3 Reverting Changes Using Git
@@ -272,21 +273,21 @@
\list \list
\li \gui Git > \gui {Current File} > \gui{Undo Unstaged Changes} reverts \li \uicontrol Git > \uicontrol {Current File} > \uicontrol{Undo Unstaged Changes} reverts
all changes and resets the current file to the state of the all changes and resets the current file to the state of the
index. index.
\li \gui Git > \gui {Current File} > \gui {Undo Uncommitted Changes} \li \uicontrol Git > \uicontrol {Current File} > \uicontrol {Undo Uncommitted Changes}
reverts all changes, discarding the reverts all changes, discarding the
index. This returns the current file to the state it was in right index. This returns the current file to the state it was in right
after the last commit. after the last commit.
\li \gui Git > \gui {Local Repository} > \gui Reset opens a dialog \li \uicontrol Git > \uicontrol {Local Repository} > \uicontrol Reset opens a dialog
where you can select the SHA-1 to reset the working directory to. where you can select the SHA-1 to reset the working directory to.
This is useful after applying patches for review, for example. You This is useful after applying patches for review, for example. You
can choose between a \gui Soft reset that does not touch the index can choose between a \uicontrol Soft reset that does not touch the index
file nor the working tree at all, a \gui Hard reset that discards file nor the working tree at all, a \uicontrol Hard reset that discards
all changes to tracked files in working tree, and a \gui Mixed all changes to tracked files in working tree, and a \uicontrol Mixed
reset that resets HEAD and the index (nothing remains staged) reset that resets HEAD and the index (nothing remains staged)
without touching the working directory. without touching the working directory.
@@ -294,12 +295,12 @@
\section2 Viewing Status \section2 Viewing Status
You can select \gui{Status} to view the status of the project or You can select \uicontrol{Status} to view the status of the project or
repository. repository.
\section2 Updating the Working Tree \section2 Updating the Working Tree
You can select \gui Update to update your working tree with the latest You can select \uicontrol Update to update your working tree with the latest
changes from the branch. Some version control systems allow you to choose changes from the branch. Some version control systems allow you to choose
between updating the current project and updating all projects. between updating the current project and updating all projects.
@@ -308,7 +309,7 @@
\section2 Deleting Files \section2 Deleting Files
You can select \gui Delete to delete obsolete files from the repository. You can select \uicontrol Delete to delete obsolete files from the repository.
With Git, you delete the files from the working tree and then stage the With Git, you delete the files from the working tree and then stage the
deleted files for a commit. deleted files for a commit.
@@ -317,20 +318,20 @@
Bazaar is a free version control system sponsored by Canonical. Bazaar is a free version control system sponsored by Canonical.
The \gui Bazaar submenu contains the following additional items: The \uicontrol Bazaar submenu contains the following additional items:
\table \table
\header \header
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui Pull \li \uicontrol Pull
\li Turn the branch into a mirror of another branch. \li Turn the branch into a mirror of another branch.
\row \row
\li \gui Push \li \uicontrol Push
\li Update a mirror of the branch. \li Update a mirror of the branch.
\row \row
\li \gui Uncommit \li \uicontrol Uncommit
\li Remove the last committed revision. \li Remove the last committed revision.
\endtable \endtable
@@ -338,19 +339,19 @@
In Bazaar, committing changes to a branch creates a new revision that holds In Bazaar, committing changes to a branch creates a new revision that holds
a snapshot of the state of the working tree. To remove the last committed a snapshot of the state of the working tree. To remove the last committed
revision, select \gui Tools > \gui Bazaar > \gui Uncommit. revision, select \uicontrol Tools > \uicontrol Bazaar > \uicontrol Uncommit.
In the \gui Uncommit dialog, select options to keep tags that point to In the \uicontrol Uncommit dialog, select options to keep tags that point to
removed revisions and to only remove the commits from the local branch when removed revisions and to only remove the commits from the local branch when
in a checkout. in a checkout.
To remove all commits up to an entry in the revision log, specify the To remove all commits up to an entry in the revision log, specify the
revision in the \gui Revision field. revision in the \uicontrol Revision field.
To test the outcome of the \gui Uncommit command without actually removing To test the outcome of the \uicontrol Uncommit command without actually removing
anything, select \gui {Dry Run}. anything, select \uicontrol {Dry Run}.
\gui Uncommit leaves the working tree ready for a new commit. The only \uicontrol Uncommit leaves the working tree ready for a new commit. The only
change it might make is restoring pending merges that were present before change it might make is restoring pending merges that were present before
the commit. the commit.
@@ -361,30 +362,30 @@
ClearCase client plugin is available on Linux and Windows for accessing a ClearCase client plugin is available on Linux and Windows for accessing a
ClearCase server. ClearCase server.
The \gui ClearCase submenu contains the following additional items: The \uicontrol ClearCase submenu contains the following additional items:
\table \table
\header \header
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui{Check In} \li \uicontrol{Check In}
\li Create a permanent new version of the current file or all files \li Create a permanent new version of the current file or all files
in the versioned object base (VOB). in the versioned object base (VOB).
\row \row
\li \gui{Check In Activity} \li \uicontrol{Check In Activity}
\li Check in checked-out versions in the change set of the current \li Check in checked-out versions in the change set of the current
Unified Change Management (UCM) activity. Unified Change Management (UCM) activity.
\row \row
\li \gui{Check Out} \li \uicontrol{Check Out}
\li Create a writable copy of a branch. If you check out files in a \li Create a writable copy of a branch. If you check out files in a
UCM view, they are added to the change set of the UCM activity. UCM view, they are added to the change set of the UCM activity.
\row \row
\li \gui{Undo Check Out} \li \uicontrol{Undo Check Out}
\li Cancel the checkout for a file and delete the checked-out \li Cancel the checkout for a file and delete the checked-out
version. version.
\row \row
\li \gui{Undo Hijack} \li \uicontrol{Undo Hijack}
\li Resolve hijacked files. If you change the read-only attribute of \li Resolve hijacked files. If you change the read-only attribute of
a file that is loaded into a snapshot view and modify the file a file that is loaded into a snapshot view and modify the file
without checking it out, you \e hijack the file. without checking it out, you \e hijack the file.
@@ -395,8 +396,8 @@
CVS is an open source version control system. CVS is an open source version control system.
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui CVS > \gui Edit to open a file for editing. select \uicontrol Tools > \uicontrol CVS > \uicontrol Edit to open a file for editing.
To discard the changes that you made in a file, select \gui Unedit. To discard the changes that you made in a file, select \uicontrol Unedit.
\section2 Using Additional Git Functions \section2 Using Additional Git Functions
@@ -409,36 +410,39 @@
\section3 Working with the Current File \section3 Working with the Current File
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Current File} > \gui {Stage File for select \uicontrol Tools > \uicontrol Git > \uicontrol {Current File} >
\uicontrol {Stage File for
Commit} to mark a new or modified file for committing to the repository. Commit} to mark a new or modified file for committing to the repository.
To undo this function, select \gui {Unstage File from Commit}. To undo this function, select \uicontrol {Unstage File from Commit}.
\section3 Working with the Current Project \section3 Working with the Current Project
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Current Project} > \gui {Clean Project} select \uicontrol Tools > \uicontrol Git > \uicontrol {Current Project} >
\uicontrol {Clean Project}
to clean the working directory. All files that are not under version control to clean the working directory. All files that are not under version control
are displayed in the \gui {Clean Repository} dialog. Ignored files are are displayed in the \uicontrol {Clean Repository} dialog. Ignored files are
deselected by default. Select the files to delete and click \gui Delete. deselected by default. Select the files to delete and click \uicontrol Delete.
\section3 Working with Local Repositories \section3 Working with Local Repositories
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Local Repository} > \gui Clean to clean select \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} >
\uicontrol Clean to clean
the repository. the repository.
To apply latest changes to the last commit, select \gui Tools > \gui Git > To apply latest changes to the last commit, select \uicontrol Tools > \uicontrol Git >
\gui {Local Repository} > \gui {Amend Last Commit}. You can also edit the \uicontrol {Local Repository} > \uicontrol {Amend Last Commit}. You can also edit the
commit message. commit message.
To amend an earlier comment in a series of related commits, select To amend an earlier comment in a series of related commits, select
\gui Tools > \gui Git > \gui {Local Repository} > \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} >
\gui {Fixup Previous Commit}. This operation is done using interactive \uicontrol {Fixup Previous Commit}. This operation is done using interactive
rebase. In case of conflicts, a merge tool is suggested. rebase. In case of conflicts, a merge tool is suggested.
To change a series of commits in the local repository, select \gui Tools > To change a series of commits in the local repository, select \uicontrol Tools >
\gui Git > \gui {Local Repository} > \gui {Interactive Rebase}. You can \uicontrol Git > \uicontrol {Local Repository} > \uicontrol {Interactive Rebase}. You can
reorder or discard commits, squash them into a single commit, or edit the reorder or discard commits, squash them into a single commit, or edit the
commit messages. commit messages.
@@ -447,7 +451,7 @@
\section4 Working with Branches \section4 Working with Branches
To work with Git branches, select \gui{Branches}. The checked out branch To work with Git branches, select \uicontrol{Branches}. The checked out branch
is shown in bold and underlined in the list of branches. Double-click branch is shown in bold and underlined in the list of branches. Double-click branch
names to edit them. names to edit them.
@@ -460,56 +464,56 @@
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui{Refresh} \li \uicontrol{Refresh}
\li Refresh the list of branches. \li Refresh the list of branches.
\row \row
\li \gui{Add} \li \uicontrol{Add}
\li Create new tracking and non-tracking branches. \li Create new tracking and non-tracking branches.
\row \row
\li \gui{Remove} \li \uicontrol{Remove}
\li Remove a local branch. You cannot delete remote branches. \li Remove a local branch. You cannot delete remote branches.
\row \row
\li \gui Rename \li \uicontrol Rename
\li Rename a local branch. \li Rename a local branch.
\row \row
\li \gui{Checkout} \li \uicontrol{Checkout}
\li Check out the selected branch and make it current. You can stash \li Check out the selected branch and make it current. You can stash
changes you have made to tracked files. changes you have made to tracked files.
\row \row
\li \gui{Diff} \li \uicontrol{Diff}
\li Show the differences between the selected and the current \li Show the differences between the selected and the current
branch. branch.
\row \row
\li \gui{Log} \li \uicontrol{Log}
\li Show the changes in a branch. \li Show the changes in a branch.
\row \row
\li \gui Merge \li \uicontrol Merge
\li Join the development histories in two branches together. \li Join the development histories in two branches together.
If the commit you are merging can be reached by following the If the commit you are merging can be reached by following the
first commit's history, there is no divergent work to merge first commit's history, there is no divergent work to merge
together. To allow Git to move the branch pointer forward, together. To allow Git to move the branch pointer forward,
select \gui {Fast-Forward}. If you do not want to fast-forward select \uicontrol {Fast-Forward}. If you do not want to fast-forward
the branch, select \gui {No Fast-Forward}. the branch, select \uicontrol {No Fast-Forward}.
\row \row
\li \gui Rebase \li \uicontrol Rebase
\li Copy local commits to the updated upstream head. \li Copy local commits to the updated upstream head.
\row \row
\li \gui {Cherry Pick} \li \uicontrol {Cherry Pick}
\li Cherry pick the top commit from the selected branch. \li Cherry pick the top commit from the selected branch.
\row \row
\li \gui Track \li \uicontrol Track
\li Set the current branch to track the selected one. \li Set the current branch to track the selected one.
\endtable \endtable
\section4 Applying Patches \section4 Applying Patches
Patches are rewriting instructions that can be applied to a set of files. Patches are rewriting instructions that can be applied to a set of files.
To apply a patch file that is open in \QC, select \gui Tools > \gui Git > To apply a patch file that is open in \QC, select \uicontrol Tools > \uicontrol Git >
\gui {Local Repository} > \gui {Apply from Editor}. \uicontrol {Local Repository} > \uicontrol {Apply from Editor}.
To select the patch file to apply from the file system, select To select the patch file to apply from the file system, select
\gui {Apply from File}. \uicontrol {Apply from File}.
\section4 Using Stashes \section4 Using Stashes
@@ -518,25 +522,25 @@
changes to work on higher priority tasks or to pull in new chages from changes to work on higher priority tasks or to pull in new chages from
another repository. another repository.
To stash all local changes, select \gui Tools > \gui Git > To stash all local changes, select \uicontrol Tools > \uicontrol Git >
\gui {Local Repository} > \gui Stash > \gui Stash. The working copy is reset \uicontrol {Local Repository} > \uicontrol Stash > \uicontrol Stash. The working copy is reset
to the state it had after the last commit. to the state it had after the last commit.
To display a dialog that shows all known stashes with options to restore, To display a dialog that shows all known stashes with options to restore,
display or delete them, select \gui Stashes. display or delete them, select \uicontrol Stashes.
To save a snapshot of your current work under a name for later reference, To save a snapshot of your current work under a name for later reference,
select \gui {Take Snapshot}. The working copy is unchanged. For example, if select \uicontrol {Take Snapshot}. The working copy is unchanged. For example, if
you want to try something and find out later that it does not work, you can you want to try something and find out later that it does not work, you can
discard the changes and return to the state of the snapshot. discard the changes and return to the state of the snapshot.
To remove a single stashed state from the stash list and apply it on top of To remove a single stashed state from the stash list and apply it on top of
the current working tree state, select \gui {Stash Pop}. the current working tree state, select \uicontrol {Stash Pop}.
\section3 Applying Actions to Commits \section3 Applying Actions to Commits
To browse a directory or the commit history and to apply actions on the To browse a directory or the commit history and to apply actions on the
commits, select \gui Tools > \gui Git > \gui {Actions on Commits}. You can commits, select \uicontrol Tools > \uicontrol Git > \uicontrol {Actions on Commits}. You can
checkout, revert, or cherry-pick commits or view them in the diff editor. checkout, revert, or cherry-pick commits or view them in the diff editor.
\image creator-git-commit-actions.png "Select a Git Commit dialog" \image creator-git-commit-actions.png "Select a Git Commit dialog"
@@ -544,17 +548,17 @@
\section3 Working with Remote Repositories \section3 Working with Remote Repositories
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui Git > \gui {Remote Repository} > \gui Pull to select \uicontrol Tools > \uicontrol Git > \uicontrol {Remote Repository} > \uicontrol Pull to
pull changes from the remote repository. If there are locally modified pull changes from the remote repository. If there are locally modified
files, you are prompted to stash the changes. Select \gui Tools > files, you are prompted to stash the changes. Select \uicontrol Tools >
\gui Options > \gui {Version Control} > \gui Git and then select the \uicontrol Options > \uicontrol {Version Control} > \uicontrol Git and then select the
\gui {Pull with rebase} check box to perform a rebase operation while \uicontrol {Pull with rebase} check box to perform a rebase operation while
pulling. pulling.
\section4 Managing Remote Repositories \section4 Managing Remote Repositories
To manage remote repositories available in Git, select \gui Tools > \gui Git To manage remote repositories available in Git, select \uicontrol Tools > \uicontrol Git
> \gui {Remote Repository} > \gui{Manage Remotes}. Double-click the names > \uicontrol {Remote Repository} > \uicontrol{Manage Remotes}. Double-click the names
and URLs of the remote repositories to edit them. and URLs of the remote repositories to edit them.
The following operations are supported: The following operations are supported:
@@ -564,20 +568,20 @@
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui{Refresh} \li \uicontrol{Refresh}
\li Refresh the list of remote repositories. \li Refresh the list of remote repositories.
\row \row
\li \gui{Add} \li \uicontrol{Add}
\li Add a new remote repository. \li Add a new remote repository.
\row \row
\li \gui{Fetch} \li \uicontrol{Fetch}
\li Fetch all the branches and change information from a remote \li Fetch all the branches and change information from a remote
repository. repository.
\row \row
\li \gui Push \li \uicontrol Push
\li Push committed changes to the remote repository. \li Push committed changes to the remote repository.
\row \row
\li \gui{Remove} \li \uicontrol{Remove}
\li Remove a remote repository. \li Remove a remote repository.
\endtable \endtable
@@ -585,93 +589,94 @@
\section4 Using Git with Subversion \section4 Using Git with Subversion
You can use Git as a client for a Subversion server. To fetch changes from a You can use Git as a client for a Subversion server. To fetch changes from a
Subversion repository to a Git repository, select \gui Tools > \gui Git > Subversion repository to a Git repository, select \uicontrol Tools > \uicontrol Git >
\gui {Remote Repository} > \gui Subversion > \gui Fetch. \uicontrol {Remote Repository} > \uicontrol Subversion > \uicontrol Fetch.
To view the Git Subversion log, select \gui Log. To view the Git Subversion log, select \uicontrol Log.
\section4 Reviewing Code with Gerrit \section4 Reviewing Code with Gerrit
If your Git project uses Gerrit for code reviews, you can view your changes If your Git project uses Gerrit for code reviews, you can view your changes
in \QC. in \QC.
Select \gui Tools > \gui Options > \gui {Version Control} > \gui Gerrit to Select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control}
> \uicontrol Gerrit to
specify the connection to the Gerrit server. specify the connection to the Gerrit server.
\image qtcreator-gerrit-options.png \image qtcreator-gerrit-options.png
To push committed changes to Gerrit, select \gui Tools > \gui Git > To push committed changes to Gerrit, select \uicontrol Tools > \uicontrol Git >
\gui {Remote Repository} > \gui {Push to Gerrit}. \uicontrol {Remote Repository} > \uicontrol {Push to Gerrit}.
To view the same information about each change as in the Gerrit To view the same information about each change as in the Gerrit
web interface, select \gui Tools > \gui Git > \gui {Remote Repository} > web interface, select \uicontrol Tools > \uicontrol Git > \uicontrol {Remote Repository} >
\gui Gerrit. \uicontrol Gerrit.
\image qtcreator-gerrit.png \image qtcreator-gerrit.png
To view details of the selected change, select \gui Show. To view details of the selected change, select \uicontrol Show.
To cherry-pick the selected change to the local repository, select To cherry-pick the selected change to the local repository, select
\gui {Cherry Pick}. To remove the change after testing it, select \gui Tools > \uicontrol {Cherry Pick}. To remove the change after testing it, select \uicontrol Tools >
\gui Git > \gui {Local Repository} > \gui Reset. In the \uicontrol Git > \uicontrol {Local Repository} > \uicontrol Reset. In the
\gui {Undo Changes to} dialog, select the \uicontrol {Undo Changes to} dialog, select the
state to reset the working directory to, and then select \gui OK. state to reset the working directory to, and then select \uicontrol OK.
To check out the change in a headless state, select \gui Checkout. To check out the change in a headless state, select \uicontrol Checkout.
To refresh the list of changes, select \gui Refresh. To refresh the list of changes, select \uicontrol Refresh.
\section3 Working with Git Tools \section3 Working with Git Tools
To start a graphical interface to Git, select \gui Tools > \gui Git > To start a graphical interface to Git, select \uicontrol Tools > \uicontrol Git >
\gui {Git Tools} > \gui {Git Gui}. \uicontrol {Git Tools} > \uicontrol {Git Gui}.
\note On OS X, the default Git installation does not contain Git Gui. To \note On OS X, the default Git installation does not contain Git Gui. To
use Git Gui, install it separately. To start Git Gui from \QC, select use Git Gui, install it separately. To start Git Gui from \QC, select
\gui Preferences > \gui {Version Control} > \gui Git, and set the path to \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Git, and set the path to
the environment that contains Git Gui in the \gui {Prepend to PATH} field. the environment that contains Git Gui in the \uicontrol {Prepend to PATH} field.
To start the commit viewer for Git, select \gui Tools > \gui Git > To start the commit viewer for Git, select \uicontrol Tools > \uicontrol Git >
\gui {Git Tools} > \gui Gitk. You can also start the tool to view commits in \uicontrol {Git Tools} > \uicontrol Gitk. You can also start the tool to view commits in
the current document or in the folder that contains the current document. the current document or in the folder that contains the current document.
To specify arguments for running Gitk, select \gui Tools > \gui Options > To specify arguments for running Gitk, select \uicontrol Tools > \uicontrol Options >
\gui {Version Control} > \gui Git. \uicontrol {Version Control} > \uicontrol Git.
To use some other application for viewing Git history, such as GitX or To use some other application for viewing Git history, such as GitX or
QGit viewer, select \gui Tools > \gui Options > \gui {Version Control} > QGit viewer, select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control} >
\gui Git and specify the path to the application executable in the \uicontrol Git and specify the path to the application executable in the
\gui {Command} field. To start the application, select \gui Tools > \gui Git \uicontrol {Command} field. To start the application, select \uicontrol Tools > \uicontrol Git
> \gui {Git Tools} > \gui {Repository Browser}. > \uicontrol {Git Tools} > \uicontrol {Repository Browser}.
To resolve merge conflicts, select \gui Tools > \gui Git > \gui {Git Tools} To resolve merge conflicts, select \uicontrol Tools > \uicontrol Git > \uicontrol {Git Tools}
> \gui {Merge Tool}. > \uicontrol {Merge Tool}.
\section2 Using Additional Mercurial Functionality \section2 Using Additional Mercurial Functionality
Mercurial is a free, distributed source control management tool. Mercurial is a free, distributed source control management tool.
The \gui Mercurial submenu contains the following additional items: The \uicontrol Mercurial submenu contains the following additional items:
\table \table
\header \header
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui{Import} \li \uicontrol{Import}
\li Apply changes from a patch file. \li Apply changes from a patch file.
\row \row
\li \gui{Incoming} \li \uicontrol{Incoming}
\li Monitor the status of a remote repository by listing \li Monitor the status of a remote repository by listing
the changes that will be pulled. the changes that will be pulled.
\row \row
\li \gui{Outgoing} \li \uicontrol{Outgoing}
\li Monitor the status of a remote repository by listing \li Monitor the status of a remote repository by listing
the changes that will be pushed. the changes that will be pushed.
\row \row
\li \gui{Pull} \li \uicontrol{Pull}
\li Pull changes from the remote repository. \li Pull changes from the remote repository.
\row \row
\li \gui{Push} \li \uicontrol{Push}
\li Push changes to the remote repository. \li Push changes to the remote repository.
\endtable \endtable
@@ -681,36 +686,36 @@
Perforce Software. Perforce Software.
When you start \QC, it looks for the executable specified When you start \QC, it looks for the executable specified
in the \gui{P4 command} field in \gui{Tools > Options > Version in the \uicontrol{P4 command} field in \uicontrol{Tools > Options > Version
Control > Perforce}. If the file is not found, the following error Control > Perforce}. If the file is not found, the following error
message is displayed in the \gui {Version Control} output pane: message is displayed in the \uicontrol {Version Control} output pane:
\gui {Perforce: Unable to determine the repository: "p4.exe" \uicontrol {Perforce: Unable to determine the repository: "p4.exe"
terminated with exit code 1}. If you use Perforce, check that the terminated with exit code 1}. If you use Perforce, check that the
path to the executable is specified correctly in the \gui{P4 command} path to the executable is specified correctly in the \uicontrol{P4 command}
field. field.
If you do not use Perforce, you can disable the Perforce plugin to If you do not use Perforce, you can disable the Perforce plugin to
get rid of the error message. Choose \gui {Help > About Plugins} and get rid of the error message. Choose \uicontrol {Help > About Plugins} and
deselect the \gui Load check box for the \gui Perforce plugin in the deselect the \uicontrol Load check box for the \uicontrol Perforce plugin in the
\gui {Version Control} group. \uicontrol {Version Control} group.
The \gui Perforce submenu contains the following additional items: The \uicontrol Perforce submenu contains the following additional items:
\table \table
\header \header
\li Menu Item \li Menu Item
\li Description \li Description
\row \row
\li \gui{Describe} \li \uicontrol{Describe}
\li View information about changelists and the files in them. \li View information about changelists and the files in them.
\row \row
\li \gui{Edit File} \li \uicontrol{Edit File}
\li Open a file for editing. \li Open a file for editing.
\row \row
\li \gui{Opened} \li \uicontrol{Opened}
\li List files that are open for editing. \li List files that are open for editing.
\row \row
\li \gui{Pending Changes} \li \uicontrol{Pending Changes}
\li Group files for commit. \li Group files for commit.
\endtable \endtable
@@ -719,7 +724,7 @@
Subversion is an open source version control system. Subversion is an open source version control system.
In addition to the standard version control system functions, you can In addition to the standard version control system functions, you can
select \gui Tools > \gui Subversion > \gui Describe to display commit log select \uicontrol Tools > \uicontrol Subversion > \uicontrol Describe to display commit log
messages for a revision. messages for a revision.
*/ */

32
doc/src/howto/qtcreator-faq.qdoc
View File

@@ -95,7 +95,7 @@
\li Launch \QC from command line, with \li Launch \QC from command line, with
\c {-noload Welcome -noload QmlProfiler -noload QuickDesigner} arguments. \c {-noload Welcome -noload QmlProfiler -noload QuickDesigner} arguments.
\li Disable the plugins permanently by selecting \gui Help > \gui{About Plugins}. \li Disable the plugins permanently by selecting \uicontrol Help > \uicontrol{About Plugins}.
\endlist \endlist
@@ -143,7 +143,7 @@
compiler. What should I do?} compiler. What should I do?}
Make sure that the application is in your system PATH when starting \QC. Make sure that the application is in your system PATH when starting \QC.
Also select \gui {Tools > Options} to check the settings specified Also select \uicontrol {Tools > Options} to check the settings specified
for the application. Many plugins specify either the path to the tool they for the application. Many plugins specify either the path to the tool they
need or the environment they run in. need or the environment they run in.
@@ -154,8 +154,8 @@
\QC has been localized into several languages. If the system \QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected. language is one of the supported languages, it is automatically selected.
To change the language, select \gui {Tools > Options > Environment} and To change the language, select \uicontrol {Tools > Options > Environment} and
select a language in the \gui Language field. The change takes effect after select a language in the \uicontrol Language field. The change takes effect after
you restart \QC. you restart \QC.
\b {Has a reported issue been addressed?} \b {Has a reported issue been addressed?}
@@ -174,10 +174,10 @@
the Qt Help plugin. The integrated Qt Reference Documentation is available the Qt Help plugin. The integrated Qt Reference Documentation is available
for Qt 4.4 and later. \QC and other Qt deliverables contain for Qt 4.4 and later. \QC and other Qt deliverables contain
documentation as .qch files. All the documentation is accessible in the documentation as .qch files. All the documentation is accessible in the
\gui Help mode. \uicontrol Help mode.
To view the documentation that is available and to add documentation, To view the documentation that is available and to add documentation,
select \gui {Tools > Options > Help > Documentation}. For more select \uicontrol {Tools > Options > Help > Documentation}. For more
information, see \l{Adding External Documentation}. information, see \l{Adding External Documentation}.
\section1 Debugger Questions \section1 Debugger Questions
@@ -200,28 +200,28 @@
\b {How do I generate a core file in \QC?} \b {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging, To trigger the GDB command that generates a core file while debugging,
select \gui {Window > Views > Debugger Log}. In the \gui Command field, select \uicontrol {Window > Views > Debugger Log}. In the \uicontrol Command field,
type \c gcore and press \key Enter. The core file is created in the type \c gcore and press \key Enter. The core file is created in the
current working directory. You can specify another location for the file, current working directory. You can specify another location for the file,
including a relative or absolute path, as an argument of the command. including a relative or absolute path, as an argument of the command.
To generate a temporary core file, select \gui {Create Snapshot} in the To generate a temporary core file, select \uicontrol {Create Snapshot} in the
context menu in the \gui Snapshot view. The core file is deleted when you context menu in the \uicontrol Snapshot view. The core file is deleted when you
stop debugging. stop debugging.
\section1 Compiler Questions \section1 Compiler Questions
\b {How can I make use of my multi-core CPU with \QC?} \b {How can I make use of my multi-core CPU with \QC?}
On Linux and OS X, go to \gui Project mode, select your configuration On Linux and OS X, go to \uicontrol Project mode, select your configuration
in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the in the \uicontrol {Build Settings}, locate the \uicontrol {Build Steps}, and add the
following value, where \c{<num>} is the amount of cores in your CPU: following value, where \c{<num>} is the amount of cores in your CPU:
\c{-j <num>} \c{-j <num>}
On Windows, nmake does not support the \c{-j} parameter. Instead, we On Windows, nmake does not support the \c{-j} parameter. Instead, we
provide a drop-in replacement called jom. You can download a precompiled provide a drop-in replacement called jom. You can download a precompiled
version of jom from \l{http://releases.qt-project.org/jom/}{Qt Project Release server}. version of jom from \l{http://releases.qt-project.org/jom/}{Qt Project Release server}.
Put jom.exe in a location in the %PATH%. Go to the \gui {Build Settings} Put jom.exe in a location in the %PATH%. Go to the \uicontrol {Build Settings}
and set jom.exe as the make command. and set jom.exe as the make command.
\note Unlike GNU make, jom automatically detects your cores and spawns as \note Unlike GNU make, jom automatically detects your cores and spawns as
@@ -256,9 +256,9 @@
\b {On Unix (Linux and OS X):} \c qDebug() and related functions use \b {On Unix (Linux and OS X):} \c qDebug() and related functions use
the standard output and error output. When you run or debug the the standard output and error output. When you run or debug the
application, you can view the output in the \gui{Application Output} pane. application, you can view the output in the \uicontrol{Application Output} pane.
For console applications that require input, select \gui {Projects > Run For console applications that require input, select \uicontrol {Projects > Run
Settings > Run in terminal}. Settings > Run in terminal}.
\b {On Windows:} Output is displayed differently for \e{console \b {On Windows:} Output is displayed differently for \e{console
@@ -273,12 +273,12 @@
type of application, \c qDebug() and related functions use standard output type of application, \c qDebug() and related functions use standard output
and error output. and error output.
We recommend that you select \gui {Projects > Run Settings > Run in We recommend that you select \uicontrol {Projects > Run Settings > Run in
terminal} for console applications. terminal} for console applications.
For GUI applications, \c qDebug() and related functions use the Windows API For GUI applications, \c qDebug() and related functions use the Windows API
function \c OutputDebugString(). The output is displayed in the function \c OutputDebugString(). The output is displayed in the
\gui{Application Output} pane. However, only one output pane tab may be \uicontrol{Application Output} pane. However, only one output pane tab may be
open at a time or the output is not displayed correctly. You can use an open at a time or the output is not displayed correctly. You can use an
external debug output viewer, such as the external debug output viewer, such as the
\l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows} \l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows}

32
doc/src/ios/creator-ios-dev.qdoc
View File

@@ -55,9 +55,9 @@
\list 1 \list 1
\li Select \gui Window > \gui Organizer. \li Select \uicontrol Window > \uicontrol Organizer.
\li Select the \gui + button to add the connected device. \li Select the \uicontrol + button to add the connected device.
\li Select the device you want to add in the list of devices. \li Select the device you want to add in the list of devices.
@@ -81,13 +81,13 @@
The next time you connect the device to the Mac computer, \QC The next time you connect the device to the Mac computer, \QC
detects it automatically. To disable automatic connections to a detects it automatically. To disable automatic connections to a
device that you do not use for development, select \gui Preferences > device that you do not use for development, select \uicontrol Preferences >
\gui iOS, and deselect the \uicontrol iOS, and deselect the
\gui {Ask about devices not in developer mode} check box. \uicontrol {Ask about devices not in developer mode} check box.
\note If \QC does not detect the devices, the iOS plugin might not be \note If \QC does not detect the devices, the iOS plugin might not be
enabled. Select \gui {Qt Creator} > \gui {About Plugins} > enabled. Select \uicontrol {Qt Creator} > \uicontrol {About Plugins} >
\gui {Device Support} > \gui iOS and restart \QC. \uicontrol {Device Support} > \uicontrol iOS and restart \QC.
\li To specify build settings: \li To specify build settings:
@@ -96,14 +96,14 @@
\li Open a project for an application you want to develop for the \li Open a project for an application you want to develop for the
device. device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to \li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add a kit for building and running applications on iOS. add a kit for building and running applications on iOS.
\image qtcreator-ios-add-kit.png "Build & Run Settings" \image qtcreator-ios-add-kit.png "Build & Run Settings"
\endlist \endlist
\li Select \gui Run to specify run settings. \li Select \uicontrol Run to specify run settings.
Usually, you can use the default settings. Usually, you can use the default settings.
@@ -117,19 +117,19 @@
\note If you cannot deploy applications, because a provisioning profile is \note If you cannot deploy applications, because a provisioning profile is
missing, try refreshing the list of provisioning profiles in Xcode. Select missing, try refreshing the list of provisioning profiles in Xcode. Select
\gui Xcode > \gui Preferences > \gui Accounts > \gui {View Details}, and \uicontrol Xcode > \uicontrol Preferences > \uicontrol Accounts > \uicontrol {View Details}, and
then select the \gui Refresh button. then select the \uicontrol Refresh button.
\section1 Viewing Device Connection Status \section1 Viewing Device Connection Status
When you connect an iOS device to a Mac computer with USB, \QC When you connect an iOS device to a Mac computer with USB, \QC
automatically detects the device if you have configured it by using Xcode. automatically detects the device if you have configured it by using Xcode.
To view information about the connected device, select \gui Preferences > To view information about the connected device, select \uicontrol Preferences >
\gui Devices. \uicontrol Devices.
\image qtcreator-ios-device-configurations.png "Devices dialog" \image qtcreator-ios-device-configurations.png "Devices dialog"
If the current device state is \gui Connected, (the traffic light icon is If the current device state is \uicontrol Connected, (the traffic light icon is
orange), you need to configure the device using Xcode. orange), you need to configure the device using Xcode.
\section1 Testing on iOS Simulator \section1 Testing on iOS Simulator
@@ -141,8 +141,8 @@
simulates a predefined set of hardware devices and software versions. simulates a predefined set of hardware devices and software versions.
You can change the simulated hardware and software version in the run You can change the simulated hardware and software version in the run
settings for the project. Select \gui Projects > \gui Run, and then select settings for the project. Select \uicontrol Projects > \uicontrol Run, and then select
the device to simulate in the \gui {Device type} field. the device to simulate in the \uicontrol {Device type} field.
\QC uses the Xcode version set as current on the Mac computer. \QC uses the Xcode version set as current on the Mac computer.
To check the version, enter the following command: To check the version, enter the following command:

24
doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc
View File

@@ -33,14 +33,14 @@
You can specify settings for deploying applications to generic Linux devices You can specify settings for deploying applications to generic Linux devices
in the project .pro file. in the project .pro file.
You can view the settings in the You can view the settings in the
\gui {Run Settings}. \uicontrol {Run Settings}.
\image qtcreator-embedded-linux-deployment-overview.png "Deploy to device" \image qtcreator-embedded-linux-deployment-overview.png "Deploy to device"
The files to be installed are listed in the \gui {Deployment} step, The files to be installed are listed in the \uicontrol {Deployment} step,
the \gui {Files to deploy} field. The \gui {Local File Path} the \uicontrol {Files to deploy} field. The \uicontrol {Local File Path}
field displays the location of the file on the development PC. The field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is \uicontrol {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is installed on the device. Text in red color indicates that the information is
missing. Edit the qmake \l{Variables#installs} missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files. {INSTALLS variable} in the project .pro file to add the missing files.
@@ -63,15 +63,15 @@
\image qtcreator-embedded-linux-deployment-details.png "Deploy to embedded Linux" \image qtcreator-embedded-linux-deployment-details.png "Deploy to embedded Linux"
When you run the application on the \gui {Embedded Linux} device, When you run the application on the \uicontrol {Embedded Linux} device,
\QC deploys the application as specified by the deploy steps. By default, \QC deploys the application as specified by the deploy steps. By default,
\QC copies the application files to the device by using the SSH file \QC copies the application files to the device by using the SSH file
transfer protocol (SFTP), as specified by the \gui {Upload files via SFTP} transfer protocol (SFTP), as specified by the \uicontrol {Upload files via SFTP}
step. step.
If you have a lot of data to copy, select \gui Details in the If you have a lot of data to copy, select \uicontrol Details in the
\gui {Upload Files via SFTP} step, and then select the \uicontrol {Upload Files via SFTP} step, and then select the
\gui {Incremental deployment} check box. \QC takes note of the deployment \uicontrol {Incremental deployment} check box. \QC takes note of the deployment
time and only copies files that have changed since the last deployment. time and only copies files that have changed since the last deployment.
However, when you make major changes on the device, such as removing files However, when you make major changes on the device, such as removing files
from the device manually or flashing a new disk image, or when you use from the device manually or flashing a new disk image, or when you use
@@ -79,12 +79,12 @@
have \QC deploy all files again. have \QC deploy all files again.
To only create a tarball and not copy the files to the device, select To only create a tarball and not copy the files to the device, select
\gui {Add Deploy Step > Create tarball}. Then remove all other deploy steps. \uicontrol {Add Deploy Step > Create tarball}. Then remove all other deploy steps.
The \gui {Deploy tarball via SFTP upload} step specifies that \QC The \uicontrol {Deploy tarball via SFTP upload} step specifies that \QC
uploads the tarball to the device and extracts it. uploads the tarball to the device and extracts it.
The \gui {Check for free disk space} step is by default the first deploy step. The \uicontrol {Check for free disk space} step is by default the first deploy step.
Use it to find out whether the remote file system has enough space left to deploy your project. Use it to find out whether the remote file system has enough space left to deploy your project.
Errors due to lack of disk space can otherwise be hard to detect. Errors due to lack of disk space can otherwise be hard to detect.

6
doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc
View File

@@ -7,7 +7,7 @@
\li Specify a connection to the device. For more information, see \li Specify a connection to the device. For more information, see
\l{Connecting Embedded Linux Devices}. \l{Connecting Embedded Linux Devices}.
\li Click the \gui Run button. \li Click the \uicontrol Run button.
\endlist \endlist
@@ -17,9 +17,9 @@
\QC copies the application files to the connected device and runs the \QC copies the application files to the connected device and runs the
application. The application views are application. The application views are
displayed on the device. Command-line output is visible in the \QC displayed on the device. Command-line output is visible in the \QC
\gui {Application Output} view. \uicontrol {Application Output} view.
Choose \gui {Projects > Embedded Linux > Run} to view the settings for deploying Choose \uicontrol {Projects > Embedded Linux > Run} to view the settings for deploying
the application to the connected device. For more information, see the application to the connected device. For more information, see
\l{Specifying Run Settings for Linux-Based Devices}. \l{Specifying Run Settings for Linux-Based Devices}.

8
doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc
View File

@@ -3,7 +3,7 @@
To run and debug an application on a Linux-based device, To run and debug an application on a Linux-based device,
you must create connections from the development you must create connections from the development
host to the device and add the device configurations to host to the device and add the device configurations to
\l{glossary-buildandrun-kit}{kits}. Click \gui {Manage Kits} to add devices \l{glossary-buildandrun-kit}{kits}. Click \uicontrol {Manage Kits} to add devices
to kits. For more information, see to kits. For more information, see
\l {Connecting Embedded Linux Devices}. \l {Connecting Embedded Linux Devices}.
@@ -12,10 +12,10 @@
The run settings display the path to the The run settings display the path to the
executable file on the development host and on the device. To specify that executable file on the development host and on the device. To specify that
another application launches your application, for example, enter the another application launches your application, for example, enter the
command in the \gui {Alternate executable on device} field and select the command in the \uicontrol {Alternate executable on device} field and select the
\gui {Use this command instead} check box. \uicontrol {Use this command instead} check box.
\image qtcreator-run-settings-linux.png "Run settings for Linux-based devices" \image qtcreator-run-settings-linux.png "Run settings for Linux-based devices"
You can specify command line arguments to pass to your application in the You can specify command line arguments to pass to your application in the
\gui Arguments field. \uicontrol Arguments field.

9
doc/src/linux-mobile/linuxdev-keys.qdocinc
View File

@@ -10,17 +10,18 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Devices > \gui {Create New}. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \uicontrol {Create New}.
\image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog" \image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
\li In the \gui {Private key file} field, select the location to save \li In the \uicontrol {Private key file} field, select the location to save
the private key. the private key.
The \gui {Public key file} field displays the location to save the The \uicontrol {Public key file} field displays the location to save the
corresponding public key. corresponding public key.
\li Select \gui {Generate And Save Key Pair} to generate and save the \li Select \uicontrol {Generate And Save Key Pair} to generate and save the
keys at the specified locations. keys at the specified locations.
\endlist \endlist

9
doc/src/linux-mobile/linuxdev-processes.qdocinc
View File

@@ -1,12 +1,13 @@
\section2 Managing Device Processes \section2 Managing Device Processes
You can view processes running on devices and kill them. Select You can view processes running on devices and kill them. Select
\gui Tools > \gui Options > \gui Devices > \gui {Remote Processes}. \uicontrol Tools > \uicontrol Options > \uicontrol Devices >
\uicontrol {Remote Processes}.
You can filter the processes by name in the \gui {List of Processes} You can filter the processes by name in the \uicontrol {List of Processes}
dialog. dialog.
To update the process list, select \gui {Update List}. To update the process list, select \uicontrol {Update List}.
To kill a process, select it in the list, and then select \gui {Kill To kill a process, select it in the list, and then select \uicontrol {Kill
Process}. Process}.

36
doc/src/linux-mobile/linuxdev.qdoc
View File

@@ -31,14 +31,14 @@
If you have a tool chain for building applications for embedded Linux If you have a tool chain for building applications for embedded Linux
devices installed on the development PC, you can add devices installed on the development PC, you can add
it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit} it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
with \gui {Embedded Linux} device type to with \uicontrol {Embedded Linux} device type to
build and run applications on embedded Linux devices. build and run applications on embedded Linux devices.
To be able to run and debug applications on embedded Linux devices, you must To be able to run and debug applications on embedded Linux devices, you must
add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}. add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}.
You use a wizard to create the connections. You can edit the settings later You use a wizard to create the connections. You can edit the settings later
in \gui Tools > \gui Options > \gui Devices. in \uicontrol Tools > \uicontrol Options > \uicontrol Devices.
\image qtcreator-linux-device-configurations.png "Devices dialog" \image qtcreator-linux-device-configurations.png "Devices dialog"
@@ -53,11 +53,11 @@
\li Make sure that your device can be reached via an IP address. \li Make sure that your device can be reached via an IP address.
\li Select \gui {Tools > Options > Build & Run > Qt Versions > Add} to \li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add} to
add the Qt version add the Qt version
for the embedded Linux. for the embedded Linux.
\li Select \gui {Tools > Options > Build & Run > Compilers > Add} to \li Select \uicontrol {Tools > Options > Build & Run > Compilers > Add} to
add the compiler add the compiler
for building the applications. for building the applications.
@@ -66,30 +66,31 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Devices > \gui Add \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \gui {Generic Linux Device} > \gui {Start Wizard}. > \uicontrol Add > \uicontrol {Generic Linux Device}
> \uicontrol {Start Wizard}.
\image qtcreator-screenshot-devconf-linux.png "Connection Data wizard" \image qtcreator-screenshot-devconf-linux.png "Connection Data wizard"
\li In the \gui {The name to identify this configuration} field, \li In the \uicontrol {The name to identify this configuration} field,
enter a name for the connection. enter a name for the connection.
\li In the \gui {The device's host name or IP address} field, \li In the \uicontrol {The device's host name or IP address} field,
enter the host name or IP address of the device. enter the host name or IP address of the device.
This value will be available in the variable \c %{CurrentDevice:HostAddress}. This value will be available in the variable \c %{CurrentDevice:HostAddress}.
\li In the \gui {The username to log into the device} field, \li In the \uicontrol {The username to log into the device} field,
enter the username to log into the device and run the enter the username to log into the device and run the
application as. application as.
This value will be available in the variable \c %{CurrentDevice:UserName}. This value will be available in the variable \c %{CurrentDevice:UserName}.
\li In the \gui {The authentication type} field, select whether \li In the \uicontrol {The authentication type} field, select whether
to use \gui Password or \gui Key authentication, and enter to use \uicontrol Password or \uicontrol Key authentication, and enter
the user's password or the file that contains the user's the user's password or the file that contains the user's
private key. private key.
The latter will be available in the variable \c %{CurrentDevice:PrivateKeyFile}. The latter will be available in the variable \c %{CurrentDevice:PrivateKeyFile}.
\li Click \gui {Next} to create the connection. \li Click \uicontrol {Next} to create the connection.
\endlist \endlist
@@ -98,10 +99,11 @@
the SSH port number, which is available in the variable \c %{CurrentDevice:SshPort}. the SSH port number, which is available in the variable \c %{CurrentDevice:SshPort}.
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run}
> \gui Add to add a kit for building for the device. Select the > \uicontrol Kits > \uicontrol Add to add a kit for building for the device.
Select the
Qt version, compiler, and device that you added above, and choose Qt version, compiler, and device that you added above, and choose
\gui {Generic Linux Device} for the device type. \uicontrol {Generic Linux Device} for the device type.
\li To specify build settings: \li To specify build settings:
@@ -110,12 +112,12 @@
\li Open a project for an application you want to develop for the \li Open a project for an application you want to develop for the
device. device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to \li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add the kit that you specified above. add the kit that you specified above.
\endlist \endlist
\li Select \gui Run to specify run settings. \li Select \uicontrol Run to specify run settings.
\image qtcreator-run-settings-linux-devices.png "Run settings for embedded Linux devices" \image qtcreator-run-settings-linux-devices.png "Run settings for embedded Linux devices"

2
doc/src/overview/creator-advanced.qdoc
View File

@@ -86,7 +86,7 @@
\li \l{Showing Task List Files in Issues Pane} \li \l{Showing Task List Files in Issues Pane}
You can load report files created by code scanning and analysis You can load report files created by code scanning and analysis
tools to the \gui Issues output pane. You can navigate to the tools to the \uicontrol Issues output pane. You can navigate to the
corresponding source code by clicking the error message. corresponding source code by clicking the error message.
\endlist \endlist

38
doc/src/overview/creator-configuring.qdoc
View File

@@ -60,20 +60,20 @@
automatically become available in \QC. If they do not, you must add the kits automatically become available in \QC. If they do not, you must add the kits
yourself to tell \QC where everything is. yourself to tell \QC where everything is.
To add kits, select \gui Tools > \gui Options > \gui {Build & Run} > To add kits, select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\gui Kits > \gui Add. \uicontrol Kits > \uicontrol Add.
For more information, see \l{Adding Kits}. For more information, see \l{Adding Kits}.
Each kit consists of a set of values that define one environment, such as a Each kit consists of a set of values that define one environment, such as a
device, compiler, and Qt version. If you know you have installed a Qt device, compiler, and Qt version. If you know you have installed a Qt
version, but it is not listed in \gui Tools > \gui Options > version, but it is not listed in \uicontrol Tools > \uicontrol Options >
\gui {Build & Run} > \gui {Qt Versions}, you must add it. \uicontrol {Build & Run} > \uicontrol {Qt Versions}, you must add it.
For more information, see \l{Adding Qt Versions}. For more information, see \l{Adding Qt Versions}.
Also check that your compiler is listed in \gui Tools > \gui Options > Also check that your compiler is listed in \uicontrol Tools > \uicontrol Options >
\gui {Build & Run} > \gui {Compilers}. \uicontrol {Build & Run} > \uicontrol {Compilers}.
For more information, see \l{Adding Compilers}. For more information, see \l{Adding Compilers}.
@@ -83,7 +83,8 @@
over a WLAN. You must also configure a connection between \QC and the over a WLAN. You must also configure a connection between \QC and the
development PC and specify the device in a kit. development PC and specify the device in a kit.
To add devices, select \gui Tools > \gui Options > \gui Devices > \gui Add. To add devices, select \uicontrol Tools > \uicontrol Options >
\uicontrol Devices > \uicontrol Add.
For more information, see \l{Connecting Mobile Devices}. For more information, see \l{Connecting Mobile Devices}.
@@ -92,7 +93,7 @@
You can use \QC with your favorite keyboard shortcuts. You can use \QC with your favorite keyboard shortcuts.
To view and edit all keyboard shortcuts defined in \QC, select To view and edit all keyboard shortcuts defined in \QC, select
\gui Tools > \gui Options > \gui Environment > \gui Keyboard. \uicontrol Tools > \uicontrol Options > \uicontrol Environment > \uicontrol Keyboard.
For more information, see \l{Keyboard Shortcuts}. For more information, see \l{Keyboard Shortcuts}.
@@ -101,8 +102,9 @@
Themes enable you to customize the appearance of the \QC UI: widgets, Themes enable you to customize the appearance of the \QC UI: widgets,
colors, and icons. colors, and icons.
To switch from the default theme to a dark theme, select \gui Tools > To switch from the default theme to a dark theme, select \uicontrol Tools >
\gui Options > \gui Environment, and then select \gui Dark in the \gui Theme \uicontrol Options > \uicontrol Environment, and then select \uicontrol Dark
in the \uicontrol Theme
field. field.
You can use the \QC text and code editors with your favorite color scheme You can use the \QC text and code editors with your favorite color scheme
@@ -112,8 +114,8 @@
The color schemes apply to highlighting C++ files, QML files, and generic The color schemes apply to highlighting C++ files, QML files, and generic
files. files.
To change the color scheme, select \gui Tools > \gui Options > To change the color scheme, select \uicontrol Tools > \uicontrol Options >
\gui {Text Editor} > \gui {Fonts & Color}. \uicontrol {Text Editor} > \uicontrol {Fonts & Color}.
For more information, see \l{Defining Color Schemes}. For more information, see \l{Defining Color Schemes}.
@@ -122,8 +124,8 @@
\l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/} \l{http://kate-editor.org/2005/03/24/writing-a-syntax-highlighting-file/}
{Kate Editor}. You can download highlight definition files for use with \QC. {Kate Editor}. You can download highlight definition files for use with \QC.
To download and use highlight definition files, select \gui Tools > To download and use highlight definition files, select \uicontrol Tools >
\gui Options > \gui {Text Editor} > \gui {Generic Highlighter}. \uicontrol Options > \uicontrol {Text Editor} > \uicontrol {Generic Highlighter}.
For more information, see \l{Generic Highlighting}. For more information, see \l{Generic Highlighting}.
@@ -134,8 +136,8 @@
the statement currently under your cursor. You can add, modify, the statement currently under your cursor. You can add, modify,
and remove snippets in the snippet editor. and remove snippets in the snippet editor.
To open the snippet editor, select \gui Tools > \gui Options > To open the snippet editor, select \uicontrol Tools > \uicontrol Options >
\gui {Text Editor} > \gui Snippets. \uicontrol {Text Editor} > \uicontrol Snippets.
For more information, see \l{Editing Code Snippets}. For more information, see \l{Editing Code Snippets}.
@@ -146,7 +148,7 @@
\QC. Once it is set up correctly on the development PC, it should just work. \QC. Once it is set up correctly on the development PC, it should just work.
However, some configuration options are available and you can set them in However, some configuration options are available and you can set them in
\gui Tools > \gui Options > \gui{Version Control} > \gui Common. \uicontrol Tools > \uicontrol Options > \uicontrol{Version Control} > \uicontrol Common.
For more information about the supported functions, see For more information about the supported functions, see
\l{Using Version Control Systems}. \l{Using Version Control Systems}.
@@ -164,6 +166,6 @@
manually disable a plugin, it stays disabled even when you upgrade to a manually disable a plugin, it stays disabled even when you upgrade to a
new \QC version, and you must manually enable it to be able to use it. new \QC version, and you must manually enable it to be able to use it.
To enable and disable plugins, select \gui Help > \gui {About Plugins}. To enable and disable plugins, select \uicontrol Help > \uicontrol {About Plugins}.
*/ */

2
doc/src/overview/creator-deployment-overview.qdoc
View File

@@ -30,7 +30,7 @@
\title Deploying to Mobile Devices \title Deploying to Mobile Devices
Deploy configurations in the \gui Project mode \gui {Run Settings} handle Deploy configurations in the \uicontrol Project mode \uicontrol {Run Settings} handle
the packaging of the application as an executable and copying it to a the packaging of the application as an executable and copying it to a
location you want to run the executable at. The files can be copied to a location you want to run the executable at. The files can be copied to a
location in the file system of the development PC or a mobile device. location in the file system of the development PC or a mobile device.

2
doc/src/overview/creator-glossary.qdoc
View File

@@ -84,7 +84,7 @@
cross-platform development easier. Each kit consists of a set cross-platform development easier. Each kit consists of a set
of values that define one environment, such as a device, of values that define one environment, such as a device,
tool chain, Qt version, and debugger command to use. Configure kits at tool chain, Qt version, and debugger command to use. Configure kits at
\gui {Tools > Options > Build & Run > Kits}. \uicontrol {Tools > Options > Build & Run > Kits}.
\row \row
\li Mode \li Mode

2
doc/src/overview/creator-help-overview.qdoc
View File

@@ -38,7 +38,7 @@
\QC comes fully integrated with Qt documentation and examples using \QC comes fully integrated with Qt documentation and examples using
the Qt Help plugin. You can add external documentation to the the Qt Help plugin. You can add external documentation to the
\gui Help mode and filter the documents displayed to find relevant \uicontrol Help mode and filter the documents displayed to find relevant
information faster. In addition, you can add bookmarks to help information faster. In addition, you can add bookmarks to help
pages. pages.

4
doc/src/overview/creator-issues.qdoc
View File

@@ -104,7 +104,7 @@
\li Creating new CMake projects with \QC is not supported. \li Creating new CMake projects with \QC is not supported.
\li If error messages displayed in the \gui {Compile Output} pane contain \li If error messages displayed in the \uicontrol {Compile Output} pane contain
paths where slashes are missing (for example, C:QtSDK), paths where slashes are missing (for example, C:QtSDK),
check your PATH variable. For more information, see check your PATH variable. For more information, see
\l{Troubleshooting MinGW Compilation Errors}. \l{Troubleshooting MinGW Compilation Errors}.
@@ -117,7 +117,7 @@
\li When debugging executables created by the GNU Compiler version 4.5.0 \li When debugging executables created by the GNU Compiler version 4.5.0
(all platforms), some data types will not be displayed in the (all platforms), some data types will not be displayed in the
\gui{Locals and Expressions} view due to missing debug information. \uicontrol{Locals and Expressions} view due to missing debug information.
\li GDB on Windows may not work if the 'Embassy \reg Security Center' \li GDB on Windows may not work if the 'Embassy \reg Security Center'
software by 'Wave \reg Systems' is installed and active (causing software by 'Wave \reg Systems' is installed and active (causing

2
doc/src/overview/creator-overview.qdoc
View File

@@ -96,7 +96,7 @@
\QC is integrated to several external native debuggers: GNU \QC is integrated to several external native debuggers: GNU
Symbolic Debugger (GDB), Microsoft Console Debugger (CDB), and Symbolic Debugger (GDB), Microsoft Console Debugger (CDB), and
internal JavaScript debugger. In the \gui Debug mode, you internal JavaScript debugger. In the \uicontrol Debug mode, you
can inspect the state of your application while debugging. can inspect the state of your application while debugging.
The memory and CPU power available on devices are limited and The memory and CPU power available on devices are limited and

11
doc/src/projects/creator-projects-autotools.qdoc
View File

@@ -39,26 +39,27 @@
\title Setting Up an Autotools Project \title Setting Up an Autotools Project
The AutotoolsProjectManager is a plugin for autotools support. It is disabled by default. 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 use the plugin, restart \QC.
To work with your Autotools project in \QC: To work with your Autotools project in \QC:
\list 1 \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 \li Select the Makefile.am file from your project. This is the only
way you can use the autotools plugin. way you can use the autotools plugin.
\li Select the build directory. Only in-source building is currently \li Select the build directory. Only in-source building is currently
supported. supported.
\li Select \gui Finish. \li Select \uicontrol Finish.
\QC displays the project tree structure. The root node displays \QC displays the project tree structure. The root node displays
the project name. All project files are listed below it and you the project name. All project files are listed below it and you
can open them from the list. can open them from the list.
\image qtcreator-autotools-buildrun.png \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 build steps (autogen.sh or autoreconf, configure, and make) are
executed. executed.
@@ -66,7 +67,7 @@
executable. executable.
\li To check and edit autotools build steps, select \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. You can add parameters to the predefined autotools build steps.

18
doc/src/projects/creator-projects-build-run-tutorial.qdoc
View File

@@ -39,23 +39,23 @@
\list 1 \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" \image qtcreator-gs-build-example-open.png "Selecting an example"
\li Select an example in the list of examples. \li Select an example in the list of examples.
You can also search for examples (2). Enter the \gui android or You can also search for examples (2). Enter the \uicontrol android or
\gui iOS keyword in the search field to list all the examples tested \uicontrol iOS keyword in the search field to list all the examples tested
for Android or iOS. 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 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}. press \key {Alt+Left}.
\li To check that the application code can be compiled and linked for a \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 \l{glossary-buildandrun-kit}{kit} for the
device. device.
@@ -67,10 +67,10 @@
\li Click \li Click
\inlineimage qtcreator-run.png \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 \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} If build errors occur, check that a \l{Adding Qt Versions}
{Qt version} and \l{Adding Compilers}{compiler} are installed and {Qt version} and \l{Adding Compilers}{compiler} are installed and
@@ -79,7 +79,7 @@
\l{Connecting iOS Devices}{iOS device}, check that the development \l{Connecting iOS Devices}{iOS device}, check that the development
environment has been set up correctly. 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. project is successfully built. The application opens on the device.
\endlist \endlist

2
doc/src/projects/creator-projects-building-running.qdoc
View File

@@ -49,7 +49,7 @@
\e {Run configurations} start the application in the location \e {Run configurations} start the application in the location
where it was copied by the \e{deploy configuration}. By default, 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, 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 if you have not made any changes to the project since you last
built and deployed it, \QC simply runs it again. built and deployed it, \QC simply runs it again.

22
doc/src/projects/creator-projects-building.qdoc
View File

@@ -41,22 +41,22 @@
To check that the application code can be compiled and linked for a device, 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 you can build the project. The build errors and warnings are displayed in
the \gui {Issues} output pane. More detailed information is displayed the \uicontrol {Issues} output pane. More detailed information is displayed
in the \gui {Compile Output} pane. in the \uicontrol {Compile Output} pane.
To build an application: To build an application:
\list 1 \list 1
\li Click the \gui {Build and Run Kit Selector} icon (1) or select \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select
\gui Build > \gui {Open Build and Run Kit Selector} to select the \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the
build and run \l{glossary-buildandrun-kit}{kit}. build and run \l{glossary-buildandrun-kit}{kit}.
\image qtcreator-kit-selector.png "Kit selector" \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. the application after building it.
\endlist \endlist
@@ -65,13 +65,13 @@
\l{Specifying Build Settings}. \l{Specifying Build Settings}.
To quickly check the compile output for changes that you made in one file or 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. subproject.
To remove all build artifacts, select \gui Build > \gui {Clean All} or To remove all build artifacts, select \uicontrol Build > \uicontrol {Clean All} or
\gui {Clean Project}. To clean the build directory and then build the \uicontrol {Clean Project}. To clean the build directory and then build the
project, select \gui Build > \gui {Rebuild All} or \gui {Rebuild Project}. 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.
*/ */

9
doc/src/projects/creator-projects-builds-customizing.qdoc
View File

@@ -31,10 +31,11 @@
\title Customizing the Build Process \title Customizing the Build Process
To specify the relationship between the release, build, To specify the relationship between the release, build,
and deploy configurations, select \gui Tools > \gui Options > \gui {Build & Run}. By and deploy configurations, select \uicontrol Tools > \uicontrol Options >
default, the \gui {Always build project before deploying it} and the \uicontrol {Build & Run}. By
\gui {Always deploy project before running it} options are enabled. default, the \uicontrol {Always build project before deploying it} and the
Therefore, when you select the \gui Run function, \QC checks for changes in \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. the project files and also builds and deploys the project if necessary.
\image qtcreator-project-options-deploy.png "Project General Options" \image qtcreator-project-options-deploy.png "Project General Options"

12
doc/src/projects/creator-projects-cmake.qdoc
View File

@@ -41,8 +41,8 @@
\section1 Setting the Path for CMake \section1 Setting the Path for CMake
You can set the path for the \c CMake executable in \gui{Tools} > You can set the path for the \c CMake executable in \uicontrol{Tools} >
\gui{Options > Build & Run > CMake}. \uicontrol{Options > Build & Run > CMake}.
\image qtcreator-cmakeexecutable.png \image qtcreator-cmakeexecutable.png
@@ -66,7 +66,7 @@
\list 1 \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. \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 \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 \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 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 \image qtcreator-cmake-build-settings.png
@@ -104,7 +104,7 @@
\section1 Running CMake Projects \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. in the \c CMake project file.
For more information about known issues for the current version, see For more information about known issues for the current version, see

58
doc/src/projects/creator-projects-compilers.qdoc
View File

@@ -68,30 +68,30 @@
For QCC, also specify the path to the BlackBerry NDK or the QNX Software For QCC, also specify the path to the BlackBerry NDK or the QNX Software
Development Platform (SDP). Development Platform (SDP).
You specify the compiler to use for each kit in \gui Tools > You specify the compiler to use for each kit in \uicontrol Tools >
\gui Options > \gui {Build & Run} > \gui Kits. \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits.
To add compilers: To add compilers:
\list 1 \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. select a compiler in the list.
\image qtcreator-toolchains.png \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. 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 to the compiler that specify the architecture on the target
platform. 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 that specify the architecture on the target platform.
The linker flags are used only when building with Qbs. The linker flags are used only when building with Qbs.
@@ -102,7 +102,7 @@
\section1 Adding Custom Compilers \section1 Adding Custom Compilers
To add a compiler that is not listed above or a remote compiler, use the 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. compiler and make tool are located and options for the compiler.
\image creator-compilers-custom.png \image creator-compilers-custom.png
@@ -111,55 +111,55 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\gui Compilers > \gui Add > \gui Custom. \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. 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. 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, compiler enables by default. Specify each macro on a separate line,
in the following format: MACRO[=value]. 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 that the compiler checks for headers. Specify each path on a
separate line. 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. 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 where mkspecs are located. Usually, the path is specified relative
to the Qt mkspecs directory. to the Qt mkspecs directory.
\li In the \gui {Error parser} field, select the error parser to use. \li In the \uicontrol {Error parser} field, select the error parser to use.
Select \gui Custom, and then select \gui {Customer Parser Settings} Select \uicontrol Custom, and then select \uicontrol {Customer Parser Settings}
to specify settings for a custom parser: to specify settings for a custom parser:
\image qtcreator-custom-parser.png \image qtcreator-custom-parser.png
\list 1 \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 a regular expression to define what is an error. The custom
parser matches the compile output line by line against the 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 output pane. Create regular expression groups that contain
the file name, line number and error message. the file name, line number and error message.
\li In the \gui {Capture Positions} field, map the regular \li In the \uicontrol {Capture Positions} field, map the regular
expression groups to \gui {File name}, \gui {Line number}, expression groups to \uicontrol {File name}, \uicontrol {Line number},
and \gui Message. and \uicontrol Message.
\li In the \gui {Test} group, you can test how the message that \li In the \uicontrol {Test} group, you can test how the message that
you enter in the \gui {Error message} field is matched when you enter in the \uicontrol {Error message} field is matched when
using the current settings. using the current settings.
\endlist \endlist
@@ -168,7 +168,7 @@
\section1 Troubleshooting MinGW Compilation Errors \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), paths where slashes are missing (for example, C:QtSDK),
check your PATH variable. At the command line, enter the following commands: check your PATH variable. At the command line, enter the following commands:

50
doc/src/projects/creator-projects-creating.qdoc
View File

@@ -57,7 +57,7 @@
of information are needed to create each configuration. For more of information are needed to create each configuration. For more
information about qmake, see the \l{qmake Manual}. information about qmake, see the \l{qmake Manual}.
You can modify the build and run settings for qmake projects in the 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 You can use wizards also to create plain C or C++ projects that use Qbs or
CMake, but do not use the Qt library. CMake, but do not use the Qt library.
@@ -222,10 +222,10 @@
\endlist \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 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 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 For examples of creating different types of projects, see
\l{Tutorials}. \l{Tutorials}.
@@ -234,11 +234,11 @@
\l {Creating Qt Quick Projects}. \l {Creating Qt Quick Projects}.
To change the location of the project directory, and to specify settings To change the location of the project directory, and to specify settings
for building and running projects, select \gui{Tools} > \gui{Options} > for building and running projects, select \uicontrol{Tools} > \uicontrol{Options} >
\gui{Build & Run} > \gui{General}. \uicontrol{Build & Run} > \uicontrol{General}.
To specify build and run settings for different target platforms, To specify build and run settings for different target platforms,
select \gui Projects. select \uicontrol Projects.
\section1 Adding Files to Projects \section1 Adding Files to Projects
@@ -264,10 +264,10 @@
application executable application executable
\li QML files, which specify items in Qt Quick projects. \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 \uicontrol {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. \uicontrol {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 Select \uicontrol {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. 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 \li JavaScript files that you can use to write the application logic in
Qt Quick projects Qt Quick projects
@@ -300,19 +300,19 @@
\section2 Creating C++ Classes \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 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. name, base class, and header and source files for the class.
The wizard supports namespaces. To use a namespace, enter a qualified 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. MyNamespace::MySubNamespace::MyClass.
\image qtcreator-cpp-class-wizard.png "Enter Class Name dialog" \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 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 > change the default suffix of a file, select \uicontrol Tools > \uicontrol Options >
\gui {C++} > \gui {File Naming}. \uicontrol {C++} > \uicontrol {File Naming}.
You can create your own project and class wizards. For more information, You can create your own project and class wizards. For more information,
see \l{Adding New Custom Wizards}. see \l{Adding New Custom Wizards}.
@@ -339,13 +339,13 @@
\section2 Displaying Additional File Types in Projects Pane \section2 Displaying Additional File Types in Projects Pane
\QC determines whether to display files from the project folder \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 .h, .qrc, and so on). To display other types of files, edit the
project file. Add filenames as values of the \c {DISTFILES} variable. project file. Add filenames as values of the \c {DISTFILES} variable.
You can also use wildcards. You can also use wildcards.
For example, the following code specifies that text files are displayed For example, the following code specifies that text files are displayed
in the \gui Projects pane: in the \uicontrol Projects pane:
\code \code
@@ -353,7 +353,7 @@
\endcode \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 \section1 Adding Subprojects to Projects
@@ -366,26 +366,26 @@
system that you use. system that you use.
When you create a new project, you can add it to another project as a 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. 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}. 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 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 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} 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. {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 To add more subprojects, right-click the project name in the \uicontrol Projects
pane, and select \gui {New Subproject} in the context menu. pane, and select \uicontrol {New Subproject} in the context menu.
To remove subprojects, right-click the project name in the \gui Projects To remove subprojects, right-click the project name in the \uicontrol Projects
pane, and select \gui {Remove Subproject} in the context menu. 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}. information, see \l{Adding Libraries to Projects}.
\section1 Related Topics \section1 Related Topics

26
doc/src/projects/creator-projects-custom-wizards.qdoc
View File

@@ -35,8 +35,8 @@
and classes. and classes.
You can copy the wizard templates in the template folders to create your own 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 project and class wizards. They are displayed in the \uicontrol New dialog that
opens when you choose \gui {File > New File or Project}. opens when you choose \uicontrol {File > New File or Project}.
In a project wizard, you can specify the files needed in a 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 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 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\helloworld} and
\c {\share\qtcreator\templates\wizards\listmodel} folders. After \c {\share\qtcreator\templates\wizards\listmodel} folders. After
you restart \QC, the \gui {Custom Classes} you restart \QC, the \uicontrol {Custom Classes}
and \gui {Custom Projects} categories (1) appear in the \gui New dialog. For 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 each category, an icon (2), a display name (3), and a description (4) are
displayed. displayed.
@@ -108,7 +108,7 @@
\li Modify the wizard_example.xml file. \li Modify the wizard_example.xml file.
\li The following code determines the type of the wizard and its place \li The following code determines the type of the wizard and its place
in the \gui New dialog: in the \uicontrol New dialog:
\code \code
@@ -137,16 +137,16 @@
\li \c id is the unique identifier for your wizard. The letter \li \c id is the unique identifier for your wizard. The letter
specifies the position of the wizard within the \c category. The specifies the position of the wizard within the \c category. The
HelloWorld wizard appears as the first wizard in the second 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 \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. The letter specifies the position of the category in the
list in the \gui New dialog. list in the \uicontrol New dialog.
\endlist \endlist
\li The following code specifies the icon and text that appear in the \li The following code specifies the icon and text that appear in the
\gui New dialog: \uicontrol New dialog:
\code \code
@@ -162,8 +162,8 @@
\list \list
\li \c displayCategory appears in the \gui New dialog, under \li \c displayCategory appears in the \uicontrol New dialog, under
\gui Projects. \uicontrol Projects.
\li \c icon appears next to the \c displayName in the middle panel \li \c icon appears next to the \c displayName in the middle panel
when \c displayCategory is selected. when \c displayCategory is selected.
@@ -204,7 +204,7 @@
\li \c target specifies the new filename for the file. The \li \c target specifies the new filename for the file. The
\c {%ProjectName%} variable is replaced with the string that \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. the wizard.
\li \c openproject indicates that the file is a project file \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%. to \c %Path%. For project wizards, it is \c %Path%/%ProjectName%.
\li \c {%CppSourceSuffix%} is replaced by the default source suffix, \li \c {%CppSourceSuffix%} is replaced by the default source suffix,
which is defined in \QC in \gui {Tools > Options > C++ > which is defined in \QC in \uicontrol {Tools > Options > C++ >
File Naming}. For example, if users enter \b MyClass, the File Naming}. For example, if users enter \b MyClass, the
filename becomes myclass.cpp when the project is created. filename becomes myclass.cpp when the project is created.
\li \c {%CppHeaderSuffix%} is replaced by the default header suffix, \li \c {%CppHeaderSuffix%} is replaced by the default header suffix,
which is also defined in \gui {File Naming}. which is also defined in \uicontrol {File Naming}.
\li \c {%CurrentDate%} is replaced by the current date in the format \li \c {%CurrentDate%} is replaced by the current date in the format
\c {YYYY-MM-DD} as specified by ISO 8601. \c {YYYY-MM-DD} as specified by ISO 8601.

14
doc/src/projects/creator-projects-debuggers.qdoc
View File

@@ -37,19 +37,19 @@
The debugger plugin automatically selects a suitable native debugger for The debugger plugin automatically selects a suitable native debugger for
each \l{glossary-buildandrun-kit}{kit} from the ones found on your system. each \l{glossary-buildandrun-kit}{kit} from the ones found on your system.
To override this choice, select \gui Tools > \gui Options > To override this choice, select \uicontrol Tools > \uicontrol Options >
\gui {Build & Run} > \gui Kits. \uicontrol {Build & Run} > \uicontrol Kits.
To add debuggers: To add debuggers:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\gui Debuggers > \gui Add. \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 \list
@@ -78,7 +78,7 @@
\endlist \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. devices.
\endlist \endlist

14
doc/src/projects/creator-projects-generic.qdoc
View File

@@ -32,7 +32,7 @@
Generic project support allows you to use \QC as a code editor. You 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 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 When you import a project, \QC creates the following files that
allow you to specify which files belong to your project and which include allow you to specify which files belong to your project and which include
@@ -45,10 +45,10 @@
\list 1 \list 1
\li Select \gui File > \gui{New File or Project} > \gui{Import Project} \li Select \uicontrol File > \uicontrol{New File or Project} > \uicontrol{Import Project}
> \gui{Import Existing 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. and select the location of the project file you want to import.
\QC automatically generates the following files in the \QC automatically generates the following files in the
@@ -96,7 +96,7 @@
is modified externally, you have to restart \QC for the changes to is modified externally, you have to restart \QC for the changes to
take effect. 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: script:
\code \code
@@ -123,12 +123,12 @@
\QC cannot automatically determine which executable to run. \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: file to run:
\list 1 \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 \li Define the configuration name, the location of the executable, any
additional arguments and the working directory. additional arguments and the working directory.

28
doc/src/projects/creator-projects-libraries.qdoc
View File

@@ -56,8 +56,8 @@
(PRE_TARGETDEPS) in the project file. (PRE_TARGETDEPS) in the project file.
Depending on the development platform, some options might be detected Depending on the development platform, some options might be detected
automatically. For example, on OS X, the library type (\gui Library or automatically. For example, on OS X, the library type (\uicontrol Library or
\gui Framework) is detected automatically and the option is hidden. However, \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 if you develop on another platform than OS X and want to build your
project for OS X, you must specify the library type. 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, 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 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. 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. for release version} option.
\QC supports code completion and syntax highlighting for the added \QC supports code completion and syntax highlighting for the added
@@ -81,9 +81,9 @@
\list 1 \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 context menu and select
\gui {Add Library}. \uicontrol {Add Library}.
\li Follow the instructions of the wizard. \li Follow the instructions of the wizard.
@@ -99,29 +99,29 @@
\list 1 \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. 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" \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. \b mylib.
\li Follow the instructions of the wizard until you get to the \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. 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 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: project file:
\code \code

20
doc/src/projects/creator-projects-opening.qdoc
View File

@@ -35,19 +35,19 @@
to enter the information. If you created the project by using another \QC 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 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 are specific to the development environment, and should not be copied from
one environment to another. Therefore, we recommend that you click \gui No one environment to another. Therefore, we recommend that you click \uicontrol No
and enter the information again in the \gui {Configure Project} tab. 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 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. Select the kits that you want to build and run the project with.
\image qtcreator-open-project-kits.png "Configure Project tab" \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 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, 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}. > Kits}.
If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, 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 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 configuration to make the exact same build as found in the directory
available to \QC. To import a build, specify a directory in the 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 You can edit the build configuration later. For more information, see
\l{Editing Build Configurations}. \l{Editing Build Configurations}.
@@ -68,11 +68,11 @@
\list 1 \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. to open.
\li In the \gui {Configure Project} tab, select kits for building and running your \li In the \uicontrol {Configure Project} tab, select kits for building and running your
project, and click \gui {Configure Project}. project, and click \uicontrol {Configure Project}.
\endlist \endlist
@@ -80,7 +80,7 @@
analysis to build up the information that it needs for functions such as analysis to build up the information that it needs for functions such as
navigation and finding usages. A progress bar is displayed during parsing. navigation and finding usages. A progress bar is displayed during parsing.
To show or hide detailed progress information, select 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" \image creator-toggle-progress-bar.png "Toggle Progress Details button"

42
doc/src/projects/creator-projects-qbs.qdoc
View File

@@ -49,9 +49,9 @@
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui {Plain C \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol {Plain C
Project (Qbs Build)} or \gui {Plain C++ Project (Qbs Build)} > Project (Qbs Build)} or \uicontrol {Plain C++ Project (Qbs Build)} >
\gui Choose, and follow the instructions of the wizard to create a \uicontrol Choose, and follow the instructions of the wizard to create a
Qbs project. Qbs project.
\image creator-qbs-project.png \image creator-qbs-project.png
@@ -60,24 +60,24 @@
\c Depends item for a Qt application. For examples, see the \c Depends item for a Qt application. For examples, see the
\c {examples} directory in the qbs repository. \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. 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 \image creator-qbs-build-app.png
\list 1 \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 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. 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. 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. Qt Quick application projects.
\note Debugging requires opening a socket at a well-known \note Debugging requires opening a socket at a well-known
@@ -86,56 +86,56 @@
execute any JavaScript functions. Therefore, you must make execute any JavaScript functions. Therefore, you must make
sure that the port is properly protected by a firewall. 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. to the project. Use colons (:) to separate keys from values.
For more information, see For more information, see
\l{http://qt-project.org/doc/qbs/language-introduction.html} \l{http://qt-project.org/doc/qbs/language-introduction.html}
{Modules} in the Qbs Manual. {Modules} in the Qbs Manual.
\li In the \gui Flags field: \li In the \uicontrol Flags field:
\list \list
\li Select \gui {Dry run} to test building without \li Select \uicontrol {Dry run} to test building without
executing commands or making permanent executing commands or making permanent
changes to the build graph. 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. errors occur, if possible.
\endlist \endlist
\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. 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. cleaning step.
\image creator-qbs-build-clean.png \image creator-qbs-build-clean.png
\list \list
\li Select \gui {Clean all artifacts} to remove all build \li Select \uicontrol {Clean all artifacts} to remove all build
artifacts. 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. 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. occur, if possible.
\endlist \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. 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 \li Click the
\inlineimage qtcreator-run.png \inlineimage qtcreator-run.png
(\gui Run) button to deploy and run the application. (\uicontrol Run) button to deploy and run the application.
\endlist \endlist
*/ */

18
doc/src/projects/creator-projects-qt-versions.qdoc
View File

@@ -37,13 +37,13 @@
\QC automatically detects the Qt versions that are registered by \QC automatically detects the Qt versions that are registered by
your system or by installers. To view detailed information for each Qt your system or by installers. To view detailed information for each Qt
version, select it in the list and select \gui Details in the version, select it in the list and select \uicontrol Details in the
\gui {Qt version for} section. To add Qt versions, select \uicontrol {Qt version for} section. To add Qt versions, select
\gui {Tools > Options > Build & Run > Qt Versions}. \uicontrol {Tools > Options > Build & Run > Qt Versions}.
You specify the Qt version to use for each \l{glossary-buildandrun-kit} You specify the Qt version to use for each \l{glossary-buildandrun-kit}
{kit} for building and running your projects {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 \section2 Setting Up New Qt Versions
@@ -51,7 +51,7 @@
\list 1 \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 \li Select the qmake executable for the Qt version that you want to
add. add.
@@ -60,13 +60,13 @@
\image qtcreator-qt4-qtversions-add.png \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. 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. 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 QML Dumper that has been built for the Qt version. For more
information, see \l{Using Debugging Helpers}. information, see \l{Using Debugging Helpers}.
@@ -74,7 +74,7 @@
\li If the Qt version is for Blackberry or QNX, enter the path \li If the Qt version is for Blackberry or QNX, enter the path
to your installed Blackberry NDK or QNX SDK in the 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 \endlist

14
doc/src/projects/creator-projects-running.qdoc
View File

@@ -34,22 +34,22 @@
location from where it can be run on the desktop, on a device emulator or 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. simulator, or on a mobile device that is connected to the development PC.
To run executable files without deploying them first, select \gui Build > To run executable files without deploying them first, select \uicontrol Build >
\gui {Run Without Deployment}. To make this the default option, deselect the \uicontrol {Run Without Deployment}. To make this the default option, deselect the
\gui Tools > \gui Options > \gui Project > \uicontrol Tools > \uicontrol Options > \uicontrol Project >
\gui {Always deploy project before running it} option. \uicontrol {Always deploy project before running it} option.
To run applications: To run applications:
\list 1 \list 1
\li Click the \gui {Build and Run Kit Selector} icon (1) or select \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select
\gui Build > \gui {Open Build and Run Kit Selector} to select the \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the
build and run \l{glossary-buildandrun-kit}{kit}. build and run \l{glossary-buildandrun-kit}{kit}.
\image qtcreator-kit-selector.png "Kit selector" \image qtcreator-kit-selector.png "Kit selector"
\li Click the \gui Run button (2). \li Click the \uicontrol Run button (2).
\endlist \endlist

57
doc/src/projects/creator-projects-settings-build.qdoc
View File

@@ -38,17 +38,17 @@
configuration for testing and the release configuration for creating configuration for testing and the release configuration for creating
the final installation file. the final installation file.
You specify build settings in the \gui Projects mode. You specify build settings in the \uicontrol Projects mode.
To add a new build configuration, click \gui Add and select the type of 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 configuration you would like to add. You can add as many build
configurations as you need. 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 \section1 Editing Build Configurations
Select the build configuration to edit in the Select the build configuration to edit in the
\gui {Edit build configuration} field. \uicontrol {Edit build configuration} field.
\image qtcreator-projectpane.png \image qtcreator-projectpane.png
@@ -56,12 +56,13 @@
directory, as \l{glossary-shadow-build} {shadow builds}. This keeps the directory, as \l{glossary-shadow-build} {shadow builds}. This keeps the
files generated for each \l{glossary-buildandrun-kit}{build and run kit} separate. 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}, 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. checkbox.
To make in-source builds the default option for all projects, select To make in-source builds the default option for all projects, select
\gui Tools > \gui Options > \gui {Build & Run} > \gui General, and enter a \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
period (.) in the \gui {Default build directory} field. \uicontrol General, and enter a period (.) in the
\uicontrol {Default build directory} field.
\section1 Starting External Processes \section1 Starting External Processes
@@ -70,26 +71,26 @@
commands that are native to the system. It constructs the commands from commands that are native to the system. It constructs the commands from
an executable name and optional command line arguments. an executable name and optional command line arguments.
The executable name is specified in the executable fields: \gui qmake, The executable name is specified in the executable fields: \uicontrol qmake,
\gui Make, \gui Command, or \gui Executable. It is either derived from the \uicontrol Make, \uicontrol Command, or \uicontrol Executable. It is either derived from the
project or specified manually. When you specify executables manually, you project or specified manually. When you specify executables manually, you
can reference environment variables and \QC variables. However, no can reference environment variables and \QC variables. However, no
quoting rules quoting rules
apply. apply.
You can specify command-line arguments in the arguments fields: You can specify command-line arguments in the arguments fields:
\gui {Additional arguments}, \gui {Command arguments}, \uicontrol {Additional arguments}, \uicontrol {Command arguments},
\gui {Make arguments}, or \gui Arguments. You can create shell command lines \uicontrol {Make arguments}, or \uicontrol Arguments. You can create shell command lines
that can contain redirection and other advanced constructs. However, some that can contain redirection and other advanced constructs. However, some
more complex use cases, such as piping test data into the application being 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 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 \section2 Using Environment Variables
You can use any environment variables as values in the fields. For a list You can use any environment variables as values in the fields. For a list
of variable names, click \gui {Build Environment > Details} in the of variable names, click \uicontrol {Build Environment > Details} in the
\gui {Build Settings}. Environment variables are referenced using the native \uicontrol {Build Settings}. Environment variables are referenced using the native
syntax: $VARNAME or ${VARNAME} on Unix and %VARNAME% on Windows. syntax: $VARNAME or ${VARNAME} on Unix and %VARNAME% on Windows.
\section2 Using Qt Creator Variables \section2 Using Qt Creator Variables
@@ -98,12 +99,12 @@
directories. The variables take care of quoting their expansions, so you do directories. The variables take care of quoting their expansions, so you do
not need to put them in quotes. Select the not need to put them in quotes. Select the
\inlineimage qtcreator-variables-button.png \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. are available in a particular context.
\section1 Build Steps \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 can change the settings for qmake and make. \QC runs the make command using
the Qt version defined for the current build configuration. the Qt version defined for the current build configuration.
@@ -120,19 +121,19 @@
deploy QML files together with the application. \QC new project wizards deploy QML files together with the application. \QC new project wizards
create projects that the Qt Quick Compiler can compile, because they are 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 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 \note For more information about the build steps when using Qbs, see
\l{Building Applications with Qbs}. \l{Building Applications with Qbs}.
\section2 Adding Custom Build Steps \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}. Custom Process Step}.
By default, custom steps are enabled. To disable a custom step, select By default, custom steps are enabled. To disable a custom step, select
the \inlineimage qtcreator-disable-steps.png the \inlineimage qtcreator-disable-steps.png
(\gui Disable) button. (\uicontrol Disable) button.
\image qtcreator-build-steps-custom.png "Custom Process Step" \image qtcreator-build-steps-custom.png "Custom Process Step"
@@ -144,21 +145,21 @@
\image qtcreator-clean-steps.png "Clean steps" \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 \list
\li To add a clean step using make or a custom process, click \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, 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 \li To change the order of steps, click
\inlineimage qtcreator-movestep.png \inlineimage qtcreator-movestep.png
(\gui {Move Up} and \gui {Move Down}). (\uicontrol {Move Up} and \uicontrol {Move Down}).
\endlist \endlist
\note For more information about the cleaning steps when using Qbs, see \note For more information about the cleaning steps when using Qbs, see
@@ -167,7 +168,7 @@
\section1 Build Environment \section1 Build Environment
You can specify the environment you want to use for building in the 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. was started is used and modified to include the Qt version.
Depending on the selected Qt version, \QC automatically sets the Depending on the selected Qt version, \QC automatically sets the
necessary environment variables. You can edit existing environment necessary environment variables. You can edit existing environment
@@ -184,8 +185,8 @@
\section2 Batch Editing \section2 Batch Editing
To modify environment variable values for build or run environments, To modify environment variable values for build or run environments,
select \gui {Batch Edit} in the build or run settings and enter environment select \uicontrol {Batch Edit} in the build or run settings and enter environment
variables in the \gui {Edit Environment} dialog. variables in the \uicontrol {Edit Environment} dialog.
To remove a variable value from the environment, enter the variable name. 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 For example, \c TEST sets the value of the \c TEST variable empty when
@@ -204,7 +205,7 @@
\section2 Clearing the System Environment \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 environment} check box. \QC discards the current environment, and
populates a clean system environment with the environment variables that the populates a clean system environment with the environment variables that the
compilers and tools need. Therefore, the environment is never totally empty, compilers and tools need. Therefore, the environment is never totally empty,

20
doc/src/projects/creator-projects-settings-code-style.qdoc
View File

@@ -32,7 +32,7 @@
\QC uses the \l{Editing MIME Types}{MIME type} of the file to \QC uses the \l{Editing MIME Types}{MIME type} of the file to
determine which mode and editor to use for opening the file. 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. QML files in the Qt Quick editor.
You can configure the code style according to your needs. You can specify You can configure the code style according to your needs. You can specify
@@ -42,29 +42,29 @@
settings. settings.
To specify global code style settings sets for C++ files, select 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}. > Options > Qt Quick}.
To configure the editor behavior for the current project: To configure the editor behavior for the current project:
\list 1 \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 \li In the \uicontrol {Current settings} field, select the settings to modify
and click \gui Copy. 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" \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" \image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings view"

4
doc/src/projects/creator-projects-settings-dependencies.qdoc
View File

@@ -44,9 +44,9 @@
\list 1 \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 \li Select projects that must be built before the current project is
built. built.

10
doc/src/projects/creator-projects-settings-editor.qdoc
View File

@@ -32,20 +32,20 @@
\QC uses the \l{Editing MIME Types}{MIME type} of the file to \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, 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 You can configure the text editor according to your needs. You can specify
editor behavior either globally for all projects or separately for each 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}. > Text Editor > Behavior}.
To configure the text editor behavior for the current project: To configure the text editor behavior for the current project:
\list 1 \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. \li Specify text editor settings for the project.
@@ -53,7 +53,7 @@
\image qtcreator-editor-settings.png "Editor view" \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: For more information about the settings, see:

20
doc/src/projects/creator-projects-settings-overview.qdoc
View File

@@ -35,19 +35,19 @@
automatically in \QC. automatically in \QC.
To view and modify the settings for currently open projects, switch to the 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 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. run projects.
\section1 Selecting Kits \section1 Selecting Kits
\image qtcreator-project-kits.png \image qtcreator-project-kits.png
To add kits for the project, select \gui {Add Kit}. The list displays kits To add kits for the project, select \uicontrol {Add Kit}. The list displays kits
that are configured in \gui Tools > \gui Options > \gui {Build & Run} > that are configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} >
\gui Kits. To add kits to the list, select \gui {Manage Kits}. \uicontrol Kits. To add kits to the list, select \uicontrol {Manage Kits}.
For more information about adding kits, see \l{Adding 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 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}. \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 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 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 \section1 Specifying Settings
@@ -79,7 +79,7 @@
\endlist \endlist
\note If you have not configured the project for building, the \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. {Configure Projects} tab.
\li \l{Specifying Editor Settings}{Editor Settings} \li \l{Specifying Editor Settings}{Editor Settings}
@@ -90,7 +90,7 @@
\endlist \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. run settings for the active project.
If you have multiple projects open in \QC, use the tabs at the top of the If you have multiple projects open in \QC, use the tabs at the top of the

6
doc/src/projects/creator-projects-settings-run-analyze.qdocinc
View File

@@ -11,7 +11,7 @@
\list 1 \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. \li Specify Valgrind settings for the project.
@@ -29,8 +29,8 @@
\endlist \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}. Analyzer}.

6
doc/src/projects/creator-projects-settings-run-debug.qdocinc
View File

@@ -2,8 +2,8 @@
\image qtquick-debugging-settings.png "Debugger Settings" \image qtquick-debugging-settings.png "Debugger Settings"
To select the languages to debug, select the \gui {Enable C++} and To select the languages to debug, select the \uicontrol {Enable C++} and
\gui {Enable QML} check boxes. The \gui {Debug port} is the port to \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 communicate with the debugger. You can use any free port in the registered
or dynamic port range. or dynamic port range.
@@ -14,6 +14,6 @@
If you debug more than one application at a time, you might receive an error 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 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}. For more information about debugging, see \l{Debugging}.

4
doc/src/projects/creator-projects-settings-run-desktop.qdocinc
View File

@@ -4,13 +4,13 @@
and the working directory to use. The working directory defaults to and the working directory to use. The working directory defaults to
the directory of the build result. 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 If you need to run with special environment variables set up, you
also do it in the run configuration settings. also do it in the run configuration settings.
\image qtcreator-pprunsettings.png \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) (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 linked frameworks, such as the Qt framework itself. You do not need this
option for debugging your application code. option for debugging your application code.

18
doc/src/projects/creator-projects-settings-run.qdoc
View File

@@ -31,12 +31,12 @@
\title Specifying Run Settings \title Specifying Run Settings
\QC automatically creates run configurations for your project. \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 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. \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. the current settings.
\section1 Specifying Run Settings for qmake Projects \section1 Specifying Run Settings for qmake Projects
@@ -64,31 +64,31 @@
\QC automatically selects the environment used for running the application \QC automatically selects the environment used for running the application
based on the device type. You can edit the environment or select another 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 You can edit existing environment variables or add, reset and unset new
variables. variables.
\image qtcreator-run-environment.png "Run Environment section" \image qtcreator-run-environment.png "Run Environment section"
When running on the desktop, the \gui {Build Environment} is used by When running on the desktop, the \uicontrol {Build Environment} is used by
default, but you can also use the \gui {System Environment} without the default, but you can also use the \uicontrol {System Environment} without the
additions made to the build environment. For more information, see additions made to the build environment. For more information, see
\l {Build Environment}. \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 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. Usually, it does not make sense to edit the device environment.
To modify the environment variable values for the run environment, select 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 \section1 Specifying a Custom Executable to Run
If you use CMake or the generic project type in \QC, or want 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, run configuration for your project. For example, when working on a library,
you can run a test application that links against the library. you can run a test application that links against the library.

28
doc/src/projects/creator-projects-targets.qdoc
View File

@@ -62,16 +62,16 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run}
> \gui Add. > \uicontrol Kits > \uicontrol Add.
\image qtcreator-kits.png \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 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 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 logo as an icon allows you to easily see, which compiler is used to
build the project for the selected kit. 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 image is located. If you are not cross-compiling, leave this field
empty. 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 to build the project. You can add compilers to the list
if they are installed on the development PC, but were not detected if they are installed on the development PC, but were not detected
automatically. For more information, see \l{Adding Compilers}. 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 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}. 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 on the target platform. \QC automatically detects available
debuggers and displays a suitable debugger in the field. You can debuggers and displays a suitable debugger in the field. You can
add debuggers to the list. For more information, see add debuggers to the list. For more information, see
\l{Adding Debuggers}. \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 building the project. You can add Qt versions to the list if they
are installed on the development PC, but were not detected are installed on the development PC, but were not detected
automatically. For more information, see \l{Adding Qt Versions}. automatically. For more information, see \l{Adding Qt Versions}.
@@ -110,9 +110,9 @@
\QC checks the directories listed in the \c{PATH} environment \QC checks the directories listed in the \c{PATH} environment
variable for the qmake executable. If a qmake executable is found, 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 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 configuration that should be used by qmake. If you leave this field
empty, the default mkspec of the selected Qt version is used. empty, the default mkspec of the selected Qt version is used.

40
doc/src/qnx/creator-deployment-bb10.qdoc
View File

@@ -35,36 +35,54 @@
To deploy Qt applications to BlackBerry 10 devices: To deploy Qt applications to BlackBerry 10 devices:
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui {Application} \li Select \uicontrol File > \uicontrol {New File or Project}
to create a \gui {Qt Quick Application}, \gui {Qt Widgets > \uicontrol {Application} to create a
Application}, or \gui {BlackBerry Cascades Application}. \uicontrol {Qt Quick Application}, \uicontrol {Qt Widgets
Application}, or \uicontrol {BlackBerry Cascades Application}.
\li Select a BlackBerry 10 \l{glossary-buildandrun-kit}{kit} for either device or simulator. For more information about adding kits, see \l{Connecting BlackBerry 10 Devices}. \li Select a BlackBerry 10 \l{glossary-buildandrun-kit}{kit} for either device or simulator. For more information about adding kits, see \l{Connecting BlackBerry 10 Devices}.
\li When \QC prompts you to generate a BAR descriptor file, answer \gui Yes to generate the file and enable the packaging process. \li When \QC prompts you to generate a BAR descriptor file, answer
\uicontrol Yes to generate the file and enable the packaging
process.
\li You can use the BAR descriptor editor to customize the appearance and behavior of the application. \li You can use the BAR descriptor editor to customize the appearance and behavior of the application.
\li You can specify which Qt libraries your application should link to in the \gui {Create Packages} deployment step, \gui {Package in development mode} option, if you create a package in development mode: \li You can specify which Qt libraries your application should link to
in the \uicontrol {Create Packages} deployment step,
\uicontrol {Package in development mode} option, if you create a
package in development mode:
\list \list
\li Select \gui {Use Pre-installed Qt} to use Qt libraries shipped with the device. \li Select \uicontrol {Use Pre-installed Qt} to use Qt libraries
\li Select \gui{Bundle Qt in Package} to package and use the Qt version from the active BlackBerry kit. shipped with the device.
\li Select \uicontrol{Bundle Qt in Package} to package and use the
Qt version from the active BlackBerry kit.
This will significantly increase the size of your package. This will significantly increase the size of your package.
\li To use a deployed Qt version in the device, select \gui{Use Deployed Qt} and set the path under /accounts/devuser/ where Qt is deployed. To deploy a Qt version select \gui {Deploy Now}. \li To use a deployed Qt version in the device, select
\uicontrol{Use Deployed Qt} and set the path under
/accounts/devuser/ where Qt is deployed. To deploy a Qt version
select \uicontrol {Deploy Now}.
\image qtcreator-blackberry-deployQt.png "Use deployed Qt." \image qtcreator-blackberry-deployQt.png "Use deployed Qt."
\endlist \endlist
\endlist \endlist
The BAR application descriptor file in your project will serve as a template to generate the actual BAR application descriptor file in the build directory The BAR application descriptor file in your project will serve as a template to generate the actual BAR application descriptor file in the build directory
that is used for packaging. The final BAR application descriptor file depends on the options you specify in the \gui {Create Packages} deployment step. that is used for packaging. The final BAR application descriptor file
depends on the options you specify in the \uicontrol {Create Packages}
deployment step.
If you have an existing Cascades project created by QNX Momentics IDE, you can import it to \QC: If you have an existing Cascades project created by QNX Momentics IDE, you can import it to \QC:
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui {Import Project} > \gui {Momentics Cascades Project} > \gui Choose. \li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol {Import Project} > \uicontrol {Momentics Cascades
Project} > \uicontrol Choose.
\li Specify an existing Cascades project created by QNX Momentics IDE. \li Specify an existing Cascades project created by QNX Momentics IDE.
\li Specify a location for the newly created \QC project. \li Specify a location for the newly created \QC project.
\endlist \endlist
A project import report is generated into import.log file located in your project. A project import report is generated into import.log file located in your project.
\note \gui {BlackBerry Cascades Application} and \gui {Momentics Cascades Project} projects are available in the \gui {All Templates} filter, so you need to set this filter in the top-right corner of the \gui {New} dialog to enable those templates. \note \uicontrol {BlackBerry Cascades Application} and \uicontrol {Momentics
Cascades Project} projects are available in the \uicontrol {All Templates}
filter, so you need to set this filter in the top-right corner of the
\uicontrol {New} dialog to enable those templates.
\note Currently, the BlackBerry 10 devices and Simulator have Qt 4.8 libraries preinstalled. To use Qt 5 features, you must compile the Qt libraries for BlackBerry 10 yourself. For more information, see \l {http://qt-project.org/wiki/Building-Qt5-for-Blackberry}{http://qt-p roject.org/wiki/Building-Qt5-for-Blackberry}. \note Currently, the BlackBerry 10 devices and Simulator have Qt 4.8 libraries preinstalled. To use Qt 5 features, you must compile the Qt libraries for BlackBerry 10 yourself. For more information, see \l {http://qt-project.org/wiki/Building-Qt5-for-Blackberry}{http://qt-p roject.org/wiki/Building-Qt5-for-Blackberry}.

6
doc/src/qnx/creator-deployment-qnx.qdoc
View File

@@ -37,10 +37,10 @@
\image qtcreator-qnx-deployment.png "Deploy to device" \image qtcreator-qnx-deployment.png "Deploy to device"
The files to be installed are listed in the \gui {Deployment} step, The files to be installed are listed in the \uicontrol {Deployment} step,
the \gui {Files to install for subproject} field. The \gui {Local File Path} the \uicontrol {Files to install for subproject} field. The \uicontrol {Local File Path}
field displays the location of the file on the development PC. The field displays the location of the file on the development PC. The
\gui {Remote Directory} field displays the folder where the file is \uicontrol {Remote Directory} field displays the folder where the file is
installed on the device. Text in red color indicates that the information is installed on the device. Text in red color indicates that the information is
missing. Edit the qmake \l{Variables#installs} missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files. {INSTALLS variable} in the project .pro file to add the missing files.

62
doc/src/qnx/creator-developing-bb10.qdoc
View File

@@ -42,7 +42,9 @@
\section1 Setting Up BlackBerry 10 Environment in Qt Creator \section1 Setting Up BlackBerry 10 Environment in Qt Creator
To check your BlackBerry 10 configuration, including the API level, the Signing Keys and the Device registration, select \gui Tools > \gui Options > \gui BlackBerry > \gui Setup. To check your BlackBerry 10 configuration, including the API level, the
Signing Keys and the Device registration, select \uicontrol Tools >
\uicontrol Options > \uicontrol BlackBerry > \uicontrol Setup.
\image qtcreator-blackberry-setupage.png "BlackBerry setup page" \image qtcreator-blackberry-setupage.png "BlackBerry setup page"
@@ -51,41 +53,67 @@
\li Set up API Levels: \li Set up API Levels:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui BlackBerry > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol BlackBerry >
\gui {API Levels and Runtimes} to list all registered API Levels automatically \uicontrol {API Levels and Runtimes} to list all registered API Levels automatically
detected by \QC. detected by \QC.
\image qtcreator-blackberry-apilevels.png "BlackBerry API leves and Runtimes page" \image qtcreator-blackberry-apilevels.png "BlackBerry API leves and Runtimes page"
\li The API Levels printed with a bold font are active. Use \gui Activate and \gui Deactivate to change it. When an API Level is active, \QC registers kits, Qt versions, tool chains, and debuggers to enable BlackBerry 10 development against the API Level. \li The API Levels printed with a bold font are active. Use
\li Use \gui Add to install a new API Level or to register an existing one. \uicontrol Activate and \uicontrol Deactivate to change it. When
an API Level is active, \QC registers kits, Qt versions, tool
chains, and debuggers to enable BlackBerry 10 development
against the API Level.
\li Use \uicontrol Add to install a new API Level or to register an
existing one.
\li It is recommended to keep the newest version as the default API level. \QC will use the available BlackBerry tools from the default API level to implement several of the plugin functions including device management, deployment process and the BlackBerry Signing Keys support. Some of those functions require 10.2 version or newer. \li It is recommended to keep the newest version as the default API level. \QC will use the available BlackBerry tools from the default API level to implement several of the plugin functions including device management, deployment process and the BlackBerry Signing Keys support. Some of those functions require 10.2 version or newer.
\endlist \endlist
\li Set up your Signing Keys: \li Set up your Signing Keys:
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui BlackBerry > \gui Keys. \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol BlackBerry > \uicontrol Keys.
\li Register a BlackBerry Signing Authority - if you do not have any, the page will guide you to an online web form to request one. \li Register a BlackBerry Signing Authority - if you do not have any, the page will guide you to an online web form to request one.
\li Select \gui {Create Certificate} to create a Developer Certificate. \li Select \uicontrol {Create Certificate} to create a Developer
\li To package your application in development mode, select \gui Request to request a debug token or \gui Import to import a valid token. Certificate.
\li To package your application in development mode, select
\uicontrol Request to request a debug token or
\uicontrol Import to import a valid token.
\image qtcreator-blackberry-keys.png "BlackBerry Keys page" \image qtcreator-blackberry-keys.png "BlackBerry Keys page"
You can also access the debug token list in \gui Tools \gui Tools > \gui Options > \gui Devices when you register a BlackBerry device. To use the same debug token for different devices, select \gui{Edit} to add, remove or update the debug token's device PINs. You can also access the debug token list in \uicontrol Tools >
\uicontrol Options > \uicontrol Devices when you register a
BlackBerry device. To use the same debug token for different
devices, select \uicontrol{Edit} to add, remove or update the debug
token's device PINs.
\endlist \endlist
\li Register your device: \li Register your device:
\list 1 \list 1
\li On the device, select \gui Settings > \gui {Security and Privacy} > \gui {Development Mode} to switch the BlackBerry 10 device to development mode. \li On the device, select \uicontrol Settings >
\li Select \gui Tools > \gui Options > \gui Devices > \gui Add > \gui {Blackberry Device} to add a BlackBerry Device. \QC should auto detect your BlackBerry device if the default API level is set to 10.2 or newer. \uicontrol {Security and Privacy} > \uicontrol {Development Mode}
\li In the \gui {Device password} field, enter the device password. \QC will query information from the device. to switch the BlackBerry 10 device to development mode.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices
> \uicontrol Add > \uicontrol {Blackberry Device} to add a
BlackBerry Device. \QC should auto detect your BlackBerry device
if the default API level is set to 10.2 or newer.
\li In the \uicontrol {Device password} field, enter the device
password. \QC will query information from the device.
\image qtcreator-blackberry-add-device.png "BlackBerry Device Wizard" \image qtcreator-blackberry-add-device.png "BlackBerry Device Wizard"
\li Select \gui Import to import a valid debug token for the device or \gui Request to request a new token. \li Select \uicontrol Import to import a valid debug token for the
device or \uicontrol Request to request a new token.
\image qtcreator-blackberry-device-debugToken.png "BlackBerry Device debug token" \image qtcreator-blackberry-device-debugToken.png "BlackBerry Device debug token"
\li If your device is successfully added, it should be listed in \gui Tools > \gui Options > \gui {Devices}. \li If your device is successfully added, it should be listed in
\uicontrol Tools > \uicontrol Options > \uicontrol {Devices}.
\image qtcreator-blackberry-device.png "BlackBerry Device Configuration page" \image qtcreator-blackberry-device.png "BlackBerry Device Configuration page"
\li Select \gui Upload to upload your debug token to the device. \li Select \uicontrol Upload to upload your debug token to the
\li Select \gui {Connect to device} to connect to the device. You should close any other pending connections from a shell or other IDE to successfully connect your device in \QC. device.
\li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits to add your device to compatible BlackBerry 10 kits. \li Select \uicontrol {Connect to device} to connect to the device.
You should close any other pending connections from a shell or
other IDE to successfully connect your device in \QC.
\li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits to add your device to
compatible BlackBerry 10 kits.
\endlist \endlist
\endlist \endlist

50
doc/src/qnx/creator-developing-qnx.qdoc
View File

@@ -35,22 +35,22 @@
Development Mode on the device and upload a debug token to it. Development Mode on the device and upload a debug token to it.
Enabling Development Mode is done by sliding top-down on the Playbook, Enabling Development Mode is done by sliding top-down on the Playbook,
thereby opening the \gui{Preferences}. Now go to \gui{Security > thereby opening the \uicontrol{Preferences}. Now go to \uicontrol{Security >
Development Mode} and set \gui{Use Development Mode} to \gui{ON}. Enter the Development Mode} and set \uicontrol{Use Development Mode} to \uicontrol{ON}. Enter the
device password when asked to do so. device password when asked to do so.
\image qtcreator-qnx-playbook-development-mode.png \image qtcreator-qnx-playbook-development-mode.png
\section2 USB Access \section2 USB Access
The \gui{Development Address} shown in the \gui{Development Mode} settings The \uicontrol{Development Address} shown in the \uicontrol{Development Mode} settings
is the IP address to use when you are connecting the device with a USB is the IP address to use when you are connecting the device with a USB
cable to the development PC. If you are deploying over a Wi-Fi network, you cable to the development PC. If you are deploying over a Wi-Fi network, you
should use the IP address shown in \gui{Preferences > About > Network}. should use the IP address shown in \uicontrol{Preferences > About > Network}.
To enable access over USB, change \gui{Preferences > Storage & Sharing > To enable access over USB, change \uicontrol{Preferences > Storage & Sharing >
USB Connections} to \gui{Connect to Windows} if you are deploying from USB Connections} to \uicontrol{Connect to Windows} if you are deploying from
Windows, or \gui{Connect to Mac} if you are deploying from Linux or OS X. Windows, or \uicontrol{Connect to Mac} if you are deploying from Linux or OS X.
\image qtcreator-qnx-playbook-storage-sharing.png \image qtcreator-qnx-playbook-storage-sharing.png
@@ -79,43 +79,43 @@
\section1 Adding a BlackBerry Device in \QC \section1 Adding a BlackBerry Device in \QC
Adding a BlackBerry device is done using a wizard in the \gui{Device Adding a BlackBerry device is done using a wizard in the \uicontrol{Device
Configurations} options. To launch it, go to \gui Tools > \gui Options > Configurations} options. To launch it, go to \uicontrol Tools > \uicontrol Options >
\gui Devices > \gui Add > \gui {BlackBerry Device} > \gui {Start Wizard}. \uicontrol Devices > \uicontrol Add > \uicontrol {BlackBerry Device} > \uicontrol {Start Wizard}.
\image qtcreator-qnx-device-configurations-wizard-1.png "Connection details" \image qtcreator-qnx-device-configurations-wizard-1.png "Connection details"
\list \list
\li In the \gui{The name to identify this configuration} field, enter a \li In the \uicontrol{The name to identify this configuration} field, enter a
name for the device. name for the device.
\li In the \gui{The device's host name or IP address} field, enter the \li In the \uicontrol{The device's host name or IP address} field, enter the
host name or IP address of the device. host name or IP address of the device.
\li In the \gui{Device password} field, enter the password for the device. \li In the \uicontrol{Device password} field, enter the password for the device.
\li In the \gui{Device type} field, select whether it is a \gui{Physical \li In the \uicontrol{Device type} field, select whether it is a \uicontrol{Physical
device} or a \gui{Simulator} you are connecting to. device} or a \uicontrol{Simulator} you are connecting to.
\li In the \gui{Debug token} field, enter the path to the debug token \li In the \uicontrol{Debug token} field, enter the path to the debug token
that is also installed on the device. This is only necessary if you are that is also installed on the device. This is only necessary if you are
connecting to a \gui{Physical device}. connecting to a \uicontrol{Physical device}.
\li Click \gui{Next} to continue. \li Click \uicontrol{Next} to continue.
\endlist \endlist
\image qtcreator-qnx-device-configurations-wizard-2.png "SSH Key Setup" \image qtcreator-qnx-device-configurations-wizard-2.png "SSH Key Setup"
For the \gui{SSH Key Setup}, you can either select an existing \b{4096}-bit For the \uicontrol{SSH Key Setup}, you can either select an existing \b{4096}-bit
key, or click \gui{Generate} to create a new key. The generated key will be key, or click \uicontrol{Generate} to create a new key. The generated key will be
stored next to the \QC settings, in a \b{qnx} sub-directory. stored next to the \QC settings, in a \b{qnx} sub-directory.
Click \gui{Next} and then \gui{Finish} to complete setting up the device Click \uicontrol{Next} and then \uicontrol{Finish} to complete setting up the device
connection. connection.
Once the device is added, you can edit the settings directly in \gui Tools > Once the device is added, you can edit the settings directly in \uicontrol Tools >
\gui Options > \gui Devices. \uicontrol Options > \uicontrol Devices.
\image qtcreator-qnx-device-configurations.png "Devices" \image qtcreator-qnx-device-configurations.png "Devices"
\section1 Adding a QNX Neutrino Device in \QC \section1 Adding a QNX Neutrino Device in \QC
Adding a QNX Neutrino device is very similar to \l{Connecting Embedded Adding a QNX Neutrino device is very similar to \l{Connecting Embedded
Linux Devices}, except you need to select \gui{QNX Device} in the Linux Devices}, except you need to select \uicontrol{QNX Device} in the
\gui{Device Configuration} wizard. \uicontrol{Device Configuration} wizard.
*/ */

18
doc/src/qnx/creator-key-management-qnx.qdocinc
View File

@@ -1,22 +1,28 @@
\section2 Obtaining New Keys \section2 Obtaining New Keys
To request keys from the BlackBerry Signing Authority, select To request keys from the BlackBerry Signing Authority, select
\gui Tools > \gui Options > \gui BlackBerry > \gui Keys > \gui Register. \uicontrol Tools > \uicontrol Options > \uicontrol BlackBerry >
Then select the \gui {BlackBerry website} link, and follow the \uicontrol Keys > \uicontrol Register.
Then select the \uicontrol {BlackBerry website} link, and follow the
instructions. instructions.
\image qtcreator-blackberry-obtain-keys.png "Requesting new keys" \image qtcreator-blackberry-obtain-keys.png "Requesting new keys"
\section2 Registering Newly Obtained Keys \section2 Registering Newly Obtained Keys
After you register in the BlackBerry website, you should get a bbidtoken.csk file. Once you store it at the proper location as described in the email, you can check that signing keys are registered in \QC by selecting \gui Tools > \gui Options > \gui BlackBerry > \gui Keys. After you register in the BlackBerry website, you should get a bbidtoken.csk
file. Once you store it at the proper location as described in the email,
you can check that signing keys are registered in \QC by selecting
\uicontrol Tools > \uicontrol Options > \uicontrol BlackBerry >
\uicontrol Keys.
\image qtcreator-blackberry-registered-keys.png "Registered keys" \image qtcreator-blackberry-registered-keys.png "Registered keys"
\section2 Creating a New Certificate \section2 Creating a New Certificate
To create a new developer certificate, click the \gui {Create Certificate} button to To create a new developer certificate, click the
open the \gui {Create Certificate} dialog. \uicontrol {Create Certificate} button to open the
\uicontrol {Create Certificate} dialog.
\image qtcreator-blackberry-createcertificatedialog.png "Create Certificate dialog" \image qtcreator-blackberry-createcertificatedialog.png "Create Certificate dialog"
@@ -35,7 +41,7 @@
\endlist \endlist
After filling in these fields, click \gui OK and the certificate After filling in these fields, click \uicontrol OK and the certificate
will be created and registered in \QC. will be created and registered in \QC.
\image qtcreator-blackberry-registered-certificate.png "Registered certificate" \image qtcreator-blackberry-registered-certificate.png "Registered certificate"

6
doc/src/qnx/creator-projects-running-qnx.qdocinc
View File

@@ -12,7 +12,7 @@
\li Make sure that your kit has your QNX or BlackBerry 10 device set. \li Make sure that your kit has your QNX or BlackBerry 10 device set.
\li Click the \gui Run button. \li Click the \uicontrol Run button.
\endlist \endlist
@@ -22,14 +22,14 @@
If you are running on a BlackBerry device, \QC generates a BAR package, If you are running on a BlackBerry device, \QC generates a BAR package,
installs it on the device, and executes the selected application. The installs it on the device, and executes the selected application. The
application views are displayed on the device. Standard output is application views are displayed on the device. Standard output is
visible in the \QC \gui {Application Output} view. visible in the \QC \uicontrol {Application Output} view.
\note Debugging is currently only fully supported on Linux and OS X. \note Debugging is currently only fully supported on Linux and OS X.
It is not possible to insert breakpoints during runtime on Windows. It is not possible to insert breakpoints during runtime on Windows.
\section2 Troubleshooting Errors \section2 Troubleshooting Errors
For the command-line output to show up in the \gui{Application Output} For the command-line output to show up in the \uicontrol{Application Output}
view when running on a BlackBerry device, \QC needs to be able to establish view when running on a BlackBerry device, \QC needs to be able to establish
an SSH connection to the device. an SSH connection to the device.
This is only possible if QNX Momentics is not running, and the SSH key This is only possible if QNX Momentics is not running, and the SSH key

2
doc/src/qnx/creator-projects-settings-run-qnx.qdocinc
View File

@@ -2,7 +2,7 @@
To run and debug an application on a QNX or BlackBerry device, you must To run and debug an application on a QNX or BlackBerry device, you must
create connections from the development PC to the device. Click create connections from the development PC to the device. Click
\gui {Manage device configurations} to create a connection. For more \uicontrol {Manage device configurations} to create a connection. For more
information, see \l{Connecting QNX Devices}. information, see \l{Connecting QNX Devices}.
\image qtcreator-qnx-run-settings.png "Run settings for QNX devices" \image qtcreator-qnx-run-settings.png "Run settings for QNX devices"

2
doc/src/qtcreator.qdoc
View File

@@ -112,7 +112,7 @@
\li \li
\row \row
\li {3,1} \note To report bugs and suggestions to the Qt Bug \li {3,1} \note To report bugs and suggestions to the Qt Bug
Tracker, select \gui {Help > Report Bug}. Tracker, select \uicontrol {Help > Report Bug}.
You can also join the \QC mailing list at: You can also join the \QC mailing list at:
\l{http://lists.qt-project.org/mailman/listinfo/} \l{http://lists.qt-project.org/mailman/listinfo/}

50
doc/src/qtquick/creator-mobile-app-tutorial.qdoc
View File

@@ -61,30 +61,30 @@
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui Application > \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\gui {Qt Quick Application} > \gui Choose. \uicontrol {Qt Quick Application} > \uicontrol Choose.
\li In the \gui{Name} field, type \b{accelbubble}. \li In the \uicontrol{Name} field, type \b{accelbubble}.
\li In the \gui {Create in} field, enter the path for the project files. \li In the \uicontrol {Create in} field, enter the path for the project files.
For example, \c {C:\Qt\examples}, and then click \gui{Next} (or For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (or
\gui Continue on OS X). \uicontrol Continue on OS X).
\li In the \gui {Qt Quick component set} field, select \li In the \uicontrol {Qt Quick component set} field, select
\gui {Qt Quick Controls 1.1}. \uicontrol {Qt Quick Controls 1.1}.
\li Select \l{glossary-buildandrun-kit}{kits} for Android ARM and iPhone \li Select \l{glossary-buildandrun-kit}{kits} for Android ARM and iPhone
OS, and click \gui{Next}. OS, and click \uicontrol{Next}.
\note Kits are listed if they have been specified in \gui Tools > \note Kits are listed if they have been specified in \uicontrol Tools >
\gui Options > \gui {Build & Run} > \gui Kits (on Windows and Linux) \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux)
or in \gui {Qt Creator} > \gui Preferences \gui {Build & Run} > or in \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} >
\gui Kits (on OS X). \uicontrol Kits (on OS X).
\li Select \gui Next in the following dialogs to use the default \li Select \uicontrol Next in the following dialogs to use the default
settings. settings.
\li Review the project settings, and click \gui{Finish} (or \gui Done on \li Review the project settings, and click \uicontrol{Finish} (or \uicontrol Done on
OS X). OS X).
\endlist \endlist
@@ -102,12 +102,12 @@
as the QML file) from the examples directory in the Qt installation as the QML file) from the examples directory in the Qt installation
directory. For example: directory. For example:
\c {C:\Qt\Qt5.2.0\5.2.0\msvc2010\examples\sensors\accelbubble\content}. \c {C:\Qt\Qt5.2.0\5.2.0\msvc2010\examples\sensors\accelbubble\content}.
The image appears in \gui Resources. You can also use any other The image appears in \uicontrol Resources. You can also use any other
image or a QML type, instead. image or a QML type, instead.
\list 1 \list 1
\li In the \gui Projects view, double-click the main.qml file \li In the \uicontrol Projects view, double-click the main.qml file
to open it in the code editor. to open it in the code editor.
\li Modify the properties of the ApplicationWindow type to specify the \li Modify the properties of the ApplicationWindow type to specify the
@@ -120,15 +120,15 @@
\skipto /^\}/ \skipto /^\}/
\printuntil } \printuntil }
\li Click \gui Design to open the file in \QMLD. \li Click \uicontrol Design to open the file in \QMLD.
\li In the \gui Navigator, select \gui Label and press \key Delete \li In the \uicontrol Navigator, select \uicontrol Label and press \key Delete
to delete it. to delete it.
\li In \gui Library > \gui Resources, select Bluebubble.svg \li In \uicontrol Library > \uicontrol Resources, select Bluebubble.svg
and drag and drop it to the canvas. and drag and drop it to the canvas.
\li In the \gui Properties pane, \gui Id field, enter \e bubble to be \li In the \uicontrol Properties pane, \uicontrol Id field, enter \e bubble to be
able to reference the image from other places. able to reference the image from other places.
\li In the code editor, add the following new properties to the image to \li In the code editor, add the following new properties to the image to
@@ -245,7 +245,7 @@
} }
\endcode \endcode
After adding the dependencies, select \gui Build > \gui {Run qmake} to apply After adding the dependencies, select \uicontrol Build > \uicontrol {Run qmake} to apply
the changes to the Makefile of the project. the changes to the Makefile of the project.
\section1 Adding Resources \section1 Adding Resources
@@ -255,10 +255,10 @@
\list 1 \list 1
\li In the \gui Projects view, double-click the qml.qrc file to open it \li In the \uicontrol Projects view, double-click the qml.qrc file to open it
in the resource editor. in the resource editor.
\li Select \gui Add to add Bluebubble.svg. \li Select \uicontrol Add to add Bluebubble.svg.
\endlist \endlist
@@ -276,7 +276,7 @@
If you are using a device running Android v4.2.2, it should prompt you to If you are using a device running Android v4.2.2, it should prompt you to
verify the connection to allow USB debugging from the PC it is connected verify the connection to allow USB debugging from the PC it is connected
to. To avoid such prompts every time you connect the device, check to. To avoid such prompts every time you connect the device, check
"Always allow from the computer" and select \gui OK. "Always allow from the computer" and select \uicontrol OK.
\li To run the application on the device, press \key {Ctrl+R}. \li To run the application on the device, press \key {Ctrl+R}.

7
doc/src/qtquick/creator-projects-settings-run-qtquick.qdocinc
View File

@@ -1,13 +1,14 @@
\section1 Specifying Run Settings for Qt Quick UI Projects \section1 Specifying Run Settings for Qt Quick UI Projects
You can specify run settings for \l{glossary-buildandrun-kit}{kits} with \gui Desktop device type: You can specify run settings for \l{glossary-buildandrun-kit}{kits}
with \uicontrol Desktop device type:
\list \list
\li In the \gui Arguments field, you can specify command line arguments \li In the \uicontrol Arguments field, you can specify command line arguments
to be passed to the executable. to be passed to the executable.
\li In the \gui {Main QML file}, select the file that \QQV will be \li In the \uicontrol {Main QML file}, select the file that \QQV will be
started with. started with.
\endlist \endlist

106
doc/src/qtquick/qtquick-app-tutorial.qdoc
View File

@@ -47,31 +47,31 @@
\list 1 \list 1
\li Select \gui{File > New File or Project > Application > \li Select \uicontrol{File > New File or Project > Application >
Qt Quick Application > Choose}. Qt Quick Application > Choose}.
\li In the \gui{Name} field, type \b {Transitions}. \li In the \uicontrol{Name} field, type \b {Transitions}.
\li In the \gui {Create in} field, enter the path for the project files. \li In the \uicontrol {Create in} field, enter the path for the project files.
For example, \c {C:\Qt\examples}, and then click \gui{Next} (on For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (on
Windows and Linux) or \gui Continue (on OS X). Windows and Linux) or \uicontrol Continue (on OS X).
\li In the \gui {Qt Quick component set} field, select \li In the \uicontrol {Qt Quick component set} field, select
\gui {Qt Quick 2.1}. \uicontrol {Qt Quick 2.1}.
\li Select \l{glossary-buildandrun-kit}{kits} for running and building your project, \li Select \l{glossary-buildandrun-kit}{kits} for running and building your project,
and then click \gui{Next}. and then click \uicontrol{Next}.
\note Kits are listed if they have been specified in \gui Tools > \note Kits are listed if they have been specified in \uicontrol Tools >
\gui Options > \gui {Build & Run} > \gui Kits (on Windows and Linux) \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux)
or in \gui {Qt Creator} > \gui Preferences \gui {Build & Run} > or in \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} >
\gui Kits (on OS X). \uicontrol Kits (on OS X).
\li Select \gui Next in the following dialogs to use the default \li Select \uicontrol Next in the following dialogs to use the default
settings. settings.
\li Review the project settings, and click \gui{Finish} (on Windows and \li Review the project settings, and click \uicontrol{Finish} (on Windows and
Linux) or \gui Done (on OS X) to create the project. Linux) or \uicontrol Done (on OS X) to create the project.
\li Press \key {Ctrl+R} (or \key {Cmd+R}) to run the application. \li Press \key {Ctrl+R} (or \key {Cmd+R}) to run the application.
@@ -92,28 +92,28 @@
directory in the Qt installation directory. For example: directory in the Qt installation directory. For example:
\c {C:\Qt\Qt5.3.0\5.3.0\msvc2010\examples\declarative\animation\states}. The \c {C:\Qt\Qt5.3.0\5.3.0\msvc2010\examples\declarative\animation\states}. The
image appears image appears
in \gui Resources. You can also use any other image or a QML in \uicontrol Resources. You can also use any other image or a QML
type, instead. type, instead.
\list 1 \list 1
\li In the \gui Projects view, double-click the main.qml file \li In the \uicontrol Projects view, double-click the main.qml file
to open it in the code editor. to open it in the code editor.
\li Click \gui Design to open the file in \QMLD. \li Click \uicontrol Design to open the file in \QMLD.
\image qmldesigner-tutorial-desing-mode.png "Transitions project in Design Mode" \image qmldesigner-tutorial-desing-mode.png "Transitions project in Design Mode"
\li In the \gui Navigator, select \gui Text and press \key Delete to \li In the \uicontrol Navigator, select \uicontrol Text and press \key Delete to
delete it. delete it.
\li Select \gui Window to edit its properties. \li Select \uicontrol Window to edit its properties.
\image qmldesigner-tutorial-page.png "Page properties" \image qmldesigner-tutorial-page.png "Page properties"
\list a \list a
\li In the \gui Id field, enter \e page, to be able to reference the \li In the \uicontrol Id field, enter \e page, to be able to reference the
window from other places. window from other places.
\li In the code editor, set the window background color to #343434: \li In the code editor, set the window background color to #343434:
@@ -126,77 +126,77 @@
\endlist \endlist
\li In \gui Library > \gui Resources, select states.png and \li In \uicontrol Library > \uicontrol Resources, select states.png and
drag and drop it to the canvas. drag and drop it to the canvas.
\image qmldesigner-tutorial-user-icon.png "Image properties" \image qmldesigner-tutorial-user-icon.png "Image properties"
\list a \list a
\li In the \gui Id field, enter \e icon. \li In the \uicontrol Id field, enter \e icon.
\li In the \gui Position field, set \gui X to 10 and \gui Y to 20. \li In the \uicontrol Position field, set \uicontrol X to 10 and \uicontrol Y to 20.
\endlist \endlist
\li Double-click the resource file, qml.qrc, in the \gui Projects view \li Double-click the resource file, qml.qrc, in the \uicontrol Projects view
to add states.png to the resource file for deployment. to add states.png to the resource file for deployment.
\li Click \gui Add and select states.png. \li Click \uicontrol Add and select states.png.
\li In the \gui Design mode, \gui Library view, \gui {QML Types} tab, \li In the \uicontrol Design mode, \uicontrol Library view, \uicontrol {QML Types} tab,
select \gui Rectangle, select \uicontrol Rectangle,
drag and drop it to the canvas, and edit its properties. drag and drop it to the canvas, and edit its properties.
\image qmldesigner-tutorial-topleftrect.png "Rectangle properties" \image qmldesigner-tutorial-topleftrect.png "Rectangle properties"
\list a \list a
\li In the \gui Id field, enter \e topLeftRect. \li In the \uicontrol Id field, enter \e topLeftRect.
\li In the \gui Size field, set \gui W and \gui H to 64, for the \li In the \uicontrol Size field, set \uicontrol W and \uicontrol H to 64, for the
rectangle size to match the image size. rectangle size to match the image size.
\li In the \gui Color field, click the \li In the \uicontrol Color field, click the
\inlineimage qmldesigner-transparent-button.png \inlineimage qmldesigner-transparent-button.png
(\gui Transparent) button to make the rectangle transparent. (\uicontrol Transparent) button to make the rectangle transparent.
\li In the \gui Border field, set the border color to #808080. \li In the \uicontrol Border field, set the border color to #808080.
\li In the \gui Rectangle group, \gui Border field, set the border \li In the \uicontrol Rectangle group, \uicontrol Border field, set the border
width to 1. width to 1.
\note If the \gui Border field does not appear after you set the \note If the \uicontrol Border field does not appear after you set the
border color, try setting the border color to solid by clicking border color, try setting the border color to solid by clicking
the the
\inlineimage qmldesigner-solid-color-button.png \inlineimage qmldesigner-solid-color-button.png
(\gui {Solid Color}) button. (\uicontrol {Solid Color}) button.
\li In the \gui Radius field, select 6 to create rounded corners for \li In the \uicontrol Radius field, select 6 to create rounded corners for
the rectangle. the rectangle.
\li Click \gui {Layout}, and then click the top and left anchor \li Click \uicontrol {Layout}, and then click the top and left anchor
buttons to anchor the rectangle to the top left corner of the buttons to anchor the rectangle to the top left corner of the
page. page.
\image qmldesigner-tutorial-topleftrect-layout.png "Layout tab" \image qmldesigner-tutorial-topleftrect-layout.png "Layout tab"
\li In the \gui Margin field, select 20 for the top anchor and 10 \li In the \uicontrol Margin field, select 20 for the top anchor and 10
for the left anchor. for the left anchor.
\endlist \endlist
\li In the \gui Navigator, drag and drop the \gui {Mouse Area} \li In the \uicontrol Navigator, drag and drop the \uicontrol {Mouse Area}
from \e page to \e topLeftRect to make it apply only to the from \e page to \e topLeftRect to make it apply only to the
rectangle and not to the whole page. rectangle and not to the whole page.
\li Edit the \gui {Mouse Area} properties: \li Edit the \uicontrol {Mouse Area} properties:
\list a \list a
\li Click \gui {Layout}, and then click the \li Click \uicontrol {Layout}, and then click the
\inlineimage qmldesigner-anchor-fill-screen.png \inlineimage qmldesigner-anchor-fill-screen.png
(\gui {Fill to Parent}) button to anchor the mouse area to the (\uicontrol {Fill to Parent}) button to anchor the mouse area to the
rectangle. rectangle.
\li In the code editor, edit the pointer to the clicked expression \li In the code editor, edit the pointer to the clicked expression
@@ -222,7 +222,7 @@
\printuntil } \printuntil }
\printuntil } \printuntil }
\li In the \gui Navigator, copy topLeftRect (by pressing \li In the \uicontrol Navigator, copy topLeftRect (by pressing
\key {Ctrl+C}) and paste it to the canvas twice (by pressing \key {Ctrl+C}) and paste it to the canvas twice (by pressing
\key {Ctrl+V}). \QC renames the new instances of the type \key {Ctrl+V}). \QC renames the new instances of the type
topLeftRect1 and topLeftRect2. topLeftRect1 and topLeftRect2.
@@ -231,13 +231,13 @@
\list a \list a
\li In the \gui Id field, enter \e middleRightRect. \li In the \uicontrol Id field, enter \e middleRightRect.
\li In \gui {Layout}, select the vertical center anchor button and \li In \uicontrol {Layout}, select the vertical center anchor button and
then the right anchor button to then the right anchor button to
anchor the rectangle to the middle right margin of the screen. anchor the rectangle to the middle right margin of the screen.
\li In the \gui Margin field, select 10 for the right anchor and 0 \li In the \uicontrol Margin field, select 10 for the right anchor and 0
for the vertical center anchor. for the vertical center anchor.
\li In the code editor, add a pointer to a clicked expression to the \li In the code editor, add a pointer to a clicked expression to the
@@ -254,12 +254,12 @@
\list a \list a
\li In the \gui Id field, enter \e bottomLeftRect. \li In the \uicontrol Id field, enter \e bottomLeftRect.
\li In \gui {Layout}, select the bottom and left anchor buttons to \li In \uicontrol {Layout}, select the bottom and left anchor buttons to
anchor the rectangle to the bottom left margin of the screen. anchor the rectangle to the bottom left margin of the screen.
\li In the \gui Margin field, select 20 for the bottom anchor and 10 \li In the \uicontrol Margin field, select 20 for the bottom anchor and 10
for the left anchor. for the left anchor.
\li In the code editor, add a pointer to a clicked expression to the \li In the code editor, add a pointer to a clicked expression to the
@@ -342,15 +342,15 @@
\list a \list a
\li Click \gui NumberAnimation in the code editor to display the \li Click \uicontrol NumberAnimation in the code editor to display the
\inlineimage qml-toolbar-indicator.png \inlineimage qml-toolbar-indicator.png
icon, and then click the icon to open the toolbar: icon, and then click the icon to open the toolbar:
\image qmldesigner-tutorial-quick-toolbar.png "Qt Quick toolbar for animation" \image qmldesigner-tutorial-quick-toolbar.png "Qt Quick toolbar for animation"
\li In the \gui Easing field, select \gui Bounce. \li In the \uicontrol Easing field, select \uicontrol Bounce.
\li In the \gui Subtype field, select \gui Out. \li In the \uicontrol Subtype field, select \uicontrol Out.
\endlist \endlist

100
doc/src/qtquick/qtquick-buttons.qdoc
View File

@@ -34,52 +34,52 @@
\list 1 \list 1
\li Select \gui {File > New File or Project > Qt > QML File > Choose} \li Select \uicontrol {File > New File or Project > Qt > QML File > Choose}
to create a QML file called Button.qml (for example). to create a QML file called Button.qml (for example).
\note Components are listed in the \gui Library only if the \note Components are listed in the \uicontrol Library only if the
filename begins with a capital letter. filename begins with a capital letter.
\li Click \gui {Design} to edit the file in the visual editor. \li Click \uicontrol {Design} to edit the file in the visual editor.
\li In the \gui Navigator, click \gui Rectangle to set properties \li In the \uicontrol Navigator, click \uicontrol Rectangle to set properties
for it. for it.
\li In the \gui Properties pane, modify the appearance of the button. \li In the \uicontrol Properties pane, modify the appearance of the button.
\list a \list a
\li In the \gui Size field, set the width (\gui W) and height \li In the \uicontrol Size field, set the width (\uicontrol W) and height
(\gui H) of the button. (\uicontrol H) of the button.
\li In the \gui Color field, select the button color. \li In the \uicontrol Color field, select the button color.
\li In the \gui Radius field, use the slider to set the radius of \li In the \uicontrol Radius field, use the slider to set the radius of
the rectangle and produce rounded corners for the button. the rectangle and produce rounded corners for the button.
\endlist \endlist
\li Drag and drop a \gui {Text} item on top of the \gui Rectangle. This \li Drag and drop a \uicontrol {Text} item on top of the \uicontrol Rectangle. This
creates a nested item where \gui Rectangle is the parent item creates a nested item where \uicontrol Rectangle is the parent item
of \gui Text. Items are positioned relative to their parents. of \uicontrol Text. Items are positioned relative to their parents.
\li In the \gui Properties pane, edit the properties of the \gui Text \li In the \uicontrol Properties pane, edit the properties of the \uicontrol Text
item. item.
\list a \list a
\li In the \gui Text field, type \b Button. \li In the \uicontrol Text field, type \b Button.
You can select the text color in the \gui {Text color} field and the You can select the text color in the \uicontrol {Text color} field and the
font, size, and style in the font, size, and style in the
\gui Font section. \uicontrol Font section.
\li In the \gui Alignment field, select the center buttons to align \li In the \uicontrol Alignment field, select the center buttons to align
the text to the center of the button. the text to the center of the button.
\li Click \gui {Layout}, and then click the \li Click \uicontrol {Layout}, and then click the
\inlineimage qmldesigner-anchor-fill-screen.png \inlineimage qmldesigner-anchor-fill-screen.png
(\gui {Fill to Parent}) button to anchor the text to the whole (\uicontrol {Fill to Parent}) button to anchor the text to the whole
button area. button area.
\endlist \endlist
@@ -130,12 +130,12 @@
\list 1 \list 1
\li Select \gui {File > New File or Project > Qt > QML File > Choose} \li Select \uicontrol {File > New File or Project > Qt > QML File > Choose}
to create a QML file called Button.qml (for example). to create a QML file called Button.qml (for example).
\li Double-click the file to open it in the code editor. \li Double-click the file to open it in the code editor.
\li Replace the \gui Rectangle with an \gui Item, as illustrated by the \li Replace the \uicontrol Rectangle with an \uicontrol Item, as illustrated by the
following code snippet: following code snippet:
\qml \qml
@@ -144,7 +144,7 @@
} }
\endqml \endqml
\li Specify properties and set expressions for the \gui Item, as \li Specify properties and set expressions for the \uicontrol Item, as
illustrated by the following code snippet: illustrated by the following code snippet:
\qml \qml
@@ -161,83 +161,83 @@
You will point to the properties and expression later. You will point to the properties and expression later.
\li Click \gui {Design} to edit the file in the visual editor. \li Click \uicontrol {Design} to edit the file in the visual editor.
\li Drag and drop two \gui {Border Image} items from the \gui Library \li Drag and drop two \uicontrol {Border Image} items from the \uicontrol Library
to the canvas. to the canvas.
\li Drag and drop a \gui Text item to the canvas. \li Drag and drop a \uicontrol Text item to the canvas.
\li Drag and drop a \gui {Mouse Area} to the canvas. \li Drag and drop a \uicontrol {Mouse Area} to the canvas.
\li In the \gui Navigator, select \gui border_image1 to specify \li In the \uicontrol Navigator, select \uicontrol border_image1 to specify
settings for it in the \gui Properties pane: settings for it in the \uicontrol Properties pane:
\list a \list a
\li Select \gui {Set Binding} in the menu next to the \li Select \uicontrol {Set Binding} in the menu next to the
\gui Visibility check box. \uicontrol Visibility check box.
\li Enter the following expression to specify that the image is \li Enter the following expression to specify that the image is
visible when the mouse is not pressed down: visible when the mouse is not pressed down:
\c {!mouse_area1.pressed}. \c {!mouse_area1.pressed}.
\li In the \gui Source field, select the image file for the button, \li In the \uicontrol Source field, select the image file for the button,
for example button_up.png. for example button_up.png.
\li Click \gui {Layout}, and then click the \li Click \uicontrol {Layout}, and then click the
\inlineimage qmldesigner-anchor-fill-screen.png \inlineimage qmldesigner-anchor-fill-screen.png
(\gui {Fill to Parent}) button to anchor the border image to the (\uicontrol {Fill to Parent}) button to anchor the border image to the
\gui Item. \uicontrol Item.
\endlist \endlist
\li Select \gui border_image2 to specify similar settings for it: \li Select \uicontrol border_image2 to specify similar settings for it:
\list a \list a
\li Set the following epression for \gui Visibility, to specify that \li Set the following epression for \uicontrol Visibility, to specify that
the image is visible when the mouse is pressed down: the image is visible when the mouse is pressed down:
\c {mouse_area1.pressed}. \c {mouse_area1.pressed}.
\li In the \gui Source field, select the image file for the button \li In the \uicontrol Source field, select the image file for the button
when it is clicked, for example button_down.png. when it is clicked, for example button_down.png.
\li Click \gui {Layout}, and then click the \li Click \uicontrol {Layout}, and then click the
\gui {Fill to Parent} \uicontrol {Fill to Parent}
button to anchor the border image to the \gui Item. button to anchor the border image to the \uicontrol Item.
\endlist \endlist
\li Select \gui text1 to specify font size and color, and text \li Select \uicontrol text1 to specify font size and color, and text
scaling and rendering: scaling and rendering:
\list a \list a
\li In the \gui Color field, use the color picker to select \li In the \uicontrol Color field, use the color picker to select
the font color, or enter a value in the field. the font color, or enter a value in the field.
\li In the \gui Text field, select \gui {Set Binding} and \li In the \uicontrol Text field, select \uicontrol {Set Binding} and
enter a pointer to the \c {text} property that you specified enter a pointer to the \c {text} property that you specified
earlier: \c {parent.txt}. earlier: \c {parent.txt}.
\li In the \gui Size field, select \gui {Pixels} to specify the font \li In the \uicontrol Size field, select \uicontrol {Pixels} to specify the font
size in pixels. By default, the size is specified in points. size in pixels. By default, the size is specified in points.
\li In the \gui Size field, select \gui {Set Expression} and enter a \li In the \uicontrol Size field, select \uicontrol {Set Expression} and enter a
pointer to the \c {fontSize} property that you specified pointer to the \c {fontSize} property that you specified
earlier. earlier.
\li Click \gui {Layout}, and then click the \li Click \uicontrol {Layout}, and then click the
\inlineimage qmldesigner-center-in.png "Anchor buttons" \inlineimage qmldesigner-center-in.png "Anchor buttons"
(\gui {Set Vertical Anchor} and \gui {Set Horizontal Anchor}) (\uicontrol {Set Vertical Anchor} and \uicontrol {Set Horizontal Anchor})
buttons to inherit the vertical and horizontal centering from buttons to inherit the vertical and horizontal centering from
the parent. the parent.
\li Click \gui Advanced to specify scaling for the text in the \li Click \uicontrol Advanced to specify scaling for the text in the
\gui Scale field. \uicontrol Scale field.
\li Select \gui {Set Binding} and enter the following expression: \li Select \uicontrol {Set Binding} and enter the following expression:
\c {if (!mousearea1.pressed) { 1 } else { 0.95 }}. \c {if (!mousearea1.pressed) { 1 } else { 0.95 }}.
\note You can enter long and complicated expressions also in the \note You can enter long and complicated expressions also in the

18
doc/src/qtquick/qtquick-components.qdoc
View File

@@ -87,20 +87,20 @@
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \li Select \uicontrol File > \uicontrol {New File or Project} >
\gui {Files and Classes} > \gui Qt > \gui {QML File (Qt Quick 1)} or \uicontrol {Files and Classes} > \uicontrol Qt > \uicontrol {QML File (Qt Quick 1)} or
\gui {QML File (Qt Quick 2)} > \gui Choose to create a new .qml \uicontrol {QML File (Qt Quick 2)} > \uicontrol Choose to create a new .qml
file. file.
\note Components are listed in the \gui {QML Components} section of \note Components are listed in the \uicontrol {QML Components} section of
the \gui Library only if the filename begins with a capital the \uicontrol Library only if the filename begins with a capital
letter. letter.
\li Click \gui Design to open the .qml file in \QMLD. \li Click \uicontrol Design to open the .qml file in \QMLD.
\li Drag and drop a QML type from the \gui Library to the editor. \li Drag and drop a QML type from the \uicontrol Library to the editor.
\li Edit its properties in the \gui Properties pane. \li Edit its properties in the \uicontrol Properties pane.
The available properties depend on the QML type. The available properties depend on the QML type.
@@ -121,7 +121,7 @@
Components can consist of several other components. To view the component Components can consist of several other components. To view the component
hierarchy as a bread crumb path when you edit a component on the canvas, hierarchy as a bread crumb path when you edit a component on the canvas,
select \gui {Go into Component} or press \key F2. Click the component select \uicontrol {Go into Component} or press \key F2. Click the component
names in the path to navigate to them. You can easily navigate back to the names in the path to navigate to them. You can easily navigate back to the
top level when you are done editing the component. top level when you are done editing the component.

30
doc/src/qtquick/qtquick-connection-editor.qdoc
View File

@@ -35,7 +35,7 @@
\title Adding Connections \title Adding Connections
You can use the \gui {Connections} view (commercial only) to: You can use the \uicontrol {Connections} view (commercial only) to:
\list \list
@@ -57,14 +57,14 @@
\list 1 \list 1
\li Select the \gui {Connections} tab. \li Select the \uicontrol {Connections} tab.
\li Select \gui Target to add the object to connect to a signal. \li Select \uicontrol Target to add the object to connect to a signal.
\li Select \gui {Signal Handler} to select the signal that the connection \li Select \uicontrol {Signal Handler} to select the signal that the connection
will listen to from a list of all signals available for the object. will listen to from a list of all signals available for the object.
\li Select \gui Actions to specify the action to perform when \li Select \uicontrol Actions to specify the action to perform when
the signal is emitted. You use JavaScript to specify the actions. the signal is emitted. You use JavaScript to specify the actions.
\endlist \endlist
@@ -81,15 +81,15 @@
\list 1 \list 1
\li Select the \gui {Dynamic Properties} tab. \li Select the \uicontrol {Dynamic Properties} tab.
\li Select \gui Item to select the object to specify the property for. \li Select \uicontrol Item to select the object to specify the property for.
\li Select \gui Property to give a name to the property. \li Select \uicontrol Property to give a name to the property.
\li Select \gui {Property Type} to specify the type of the property. \li Select \uicontrol {Property Type} to specify the type of the property.
\li Select \gui {Property Value} to specify the value of the property. \li Select \uicontrol {Property Value} to specify the value of the property.
\endlist \endlist
@@ -104,18 +104,18 @@
\list 1 \list 1
\li Select the \gui {Bindings} tab. \li Select the \uicontrol {Bindings} tab.
\li Select \gui Item to select the target object whose property you want \li Select \uicontrol Item to select the target object whose property you want
to change dynamically. to change dynamically.
\li Select \gui Property to specify the property to bind to a source \li Select \uicontrol Property to specify the property to bind to a source
property. property.
\li Select \gui {Source Item} to specify the object whose property you \li Select \uicontrol {Source Item} to specify the object whose property you
want to use to determine the behavior of the target object. want to use to determine the behavior of the target object.
\li Select \gui {Source Property} to specify the property to bind the \li Select \uicontrol {Source Property} to specify the property to bind the
target property to. target property to.
\endlist \endlist

40
doc/src/qtquick/qtquick-creating.qdoc
View File

@@ -38,24 +38,24 @@
\list \list
\li \gui {Qt Quick Application} creates a Qt Quick application project \li \uicontrol {Qt Quick Application} creates a Qt Quick application project
that can contain both QML and C++ code. The project includes a that can contain both QML and C++ code. The project includes a
QDeclarativeView or QQuickView. You can build the application and QDeclarativeView or QQuickView. You can build the application and
deploy it to deploy it to
desktop and mobile target platforms. desktop and mobile target platforms.
\li \gui {Qt Quick UI} creates a Qt Quick UI project with a single QML \li \uicontrol {Qt Quick UI} creates a Qt Quick UI project with a single QML
file that contains the main view. You can review Qt Quick UI file that contains the main view. You can review Qt Quick UI
projects in a \l{Previewing QML Files}{preview tool} and you need projects in a \l{Previewing QML Files}{preview tool} and you need
not build them. You do not not build them. You do not
need to have the development environment installed on your need to have the development environment installed on your
computer to create and run this type of project. computer to create and run this type of project.
\li \gui {Qt Quick Extension Plugins} (in the \gui Libraries category) \li \uicontrol {Qt Quick Extension Plugins} (in the \uicontrol Libraries category)
create C++ plugins that make it possible to offer extensions that create C++ plugins that make it possible to offer extensions that
can be loaded dynamically into Qt Quick applications. Select can be loaded dynamically into Qt Quick applications. Select
\gui {Qt Quick 1 Extension Plugin} to create extensions for \uicontrol {Qt Quick 1 Extension Plugin} to create extensions for
Qt Quick 1 applications and \gui {Qt Quick 2 Extension Plugin} to Qt Quick 1 applications and \uicontrol {Qt Quick 2 Extension Plugin} to
create extensions for Qt Quick 2 applications. create extensions for Qt Quick 2 applications.
\endlist \endlist
@@ -64,10 +64,10 @@
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui Application > \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\gui {Qt Quick UI} > \gui Choose. \uicontrol {Qt Quick UI} > \uicontrol Choose.
\li In the \gui {Qt Quick component set} field, select the component set \li In the \uicontrol {Qt Quick component set} field, select the component set
to use for the project. The Qt Quick imports enable you to use the to use for the project. The Qt Quick imports enable you to use the
basic QML types to create user interfaces, whereas the Qt Quick basic QML types to create user interfaces, whereas the Qt Quick
Controls provide a set of ready-made controls that you can customize Controls provide a set of ready-made controls that you can customize
@@ -75,10 +75,10 @@
\list \list
\li Select \gui {Qt Quick Controls} or \gui {Qt Quick 2.1}, or \li Select \uicontrol {Qt Quick Controls} or \uicontrol {Qt Quick 2.1}, or
later, to develop for platforms that run Qt 5. later, to develop for platforms that run Qt 5.
\li Select \gui {Qt Quick 1.1} to develop for platforms that run \li Select \uicontrol {Qt Quick 1.1} to develop for platforms that run
Qt 4.7.4. To develop for platforms that run Qt 4.7.1, 4.7.2, or Qt 4.7.4. To develop for platforms that run Qt 4.7.1, 4.7.2, or
4.7.3, you must change the import statement to import Qt Quick 4.7.3, you must change the import statement to import Qt Quick
1.0. 1.0.
@@ -103,8 +103,8 @@
whole application UI. whole application UI.
\li .qml.ui files defines a form for the application UI. It is created \li .qml.ui files defines a form for the application UI. It is created
if you select \gui {Qt Quick Controls 1.3}, or later, or if you select \uicontrol {Qt Quick Controls 1.3}, or later, or
\gui {Qt Quick 2.4}, or later. The forms can contain a subset of the \uicontrol {Qt Quick 2.4}, or later. The forms can contain a subset of the
QML language. Similarly as with the UI forms for \QD, it is QML language. Similarly as with the UI forms for \QD, it is
recommended that you use \QMLD to edit the UI forms. For more recommended that you use \QMLD to edit the UI forms. For more
information, see \l{Qt Quick UI Forms}. information, see \l{Qt Quick UI Forms}.
@@ -118,21 +118,21 @@
\list 1 \list 1
\li Select \gui File > \gui {New File or Project} > \gui Application > \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application >
\gui {Qt Quick Application} > \gui Choose. \uicontrol {Qt Quick Application} > \uicontrol Choose.
\li In the \gui {Qt Quick component set} field, select the component set \li In the \uicontrol {Qt Quick component set} field, select the component set
to use for the project. For more information, see to use for the project. For more information, see
\l{Creating Qt Quick UI Projects}. \l{Creating Qt Quick UI Projects}.
\li Select \l{glossary-buildandrun-kit}{kits} for running and building \li Select \l{glossary-buildandrun-kit}{kits} for running and building
your project, and then click \gui{Next}. your project, and then click \uicontrol{Next}.
\note Kits are listed if they have been specified in \gui Tools > \note Kits are listed if they have been specified in \uicontrol Tools >
\gui Options > \gui {Build & Run} > \gui Kits. \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits.
\li Review the project settings, and click \gui{Finish} (on Windows and \li Review the project settings, and click \uicontrol{Finish} (on Windows and
Linux) or \gui Done (on OS X) to create the project. Linux) or \uicontrol Done (on OS X) to create the project.
\endlist \endlist

96
doc/src/qtquick/qtquick-designer.qdoc
View File

@@ -31,7 +31,7 @@
\title Using Qt Quick Designer \title Using Qt Quick Designer
You can edit \l{Qt Quick UI Forms} (ui.qml files) in \QMLD. \QC opens the You can edit \l{Qt Quick UI Forms} (ui.qml files) in \QMLD. \QC opens the
UI forms in the \gui Design mode. It is recommended that you use UI forms UI forms in the \uicontrol Design mode. It is recommended that you use UI forms
for components that you want to desing in \QMLD. for components that you want to desing in \QMLD.
\image qmldesigner-visual-editor.png "Visual editor" \image qmldesigner-visual-editor.png "Visual editor"
@@ -47,35 +47,35 @@
\list \list
\li \gui {Navigator} (1) displays the items in the current QML \li \uicontrol {Navigator} (1) displays the items in the current QML
file as tree structure. file as tree structure.
\li \gui {Library} (2) displays the building blocks that you can use \li \uicontrol {Library} (2) displays the building blocks that you can use
to design applications: predefined QML types, your own QML to design applications: predefined QML types, your own QML
components, Qt Quick components or Qt Quick Controls that you components, Qt Quick components or Qt Quick Controls that you
import to the project, and other resources. import to the project, and other resources.
\li \gui Connections (3) enables you to create connections between \li \uicontrol Connections (3) enables you to create connections between
objects, signals, and object properties (commercial only). For objects, signals, and object properties (commercial only). For
more information, see \l{Adding Connections}. more information, see \l{Adding Connections}.
\li \gui {Projects} shows a list of projects open in the current \li \uicontrol {Projects} shows a list of projects open in the current
session. For more information, see \l{Viewing Project Files}. session. For more information, see \l{Viewing Project Files}.
\li \gui {File System} shows all files in the currently selected \li \uicontrol {File System} shows all files in the currently selected
directory. For more information, see \l{Viewing the File System}. directory. For more information, see \l{Viewing the File System}.
\li \gui {Open Documents} sidebar view shows currently open files. \li \uicontrol {Open Documents} sidebar view shows currently open files.
\endlist \endlist
\li \gui Canvas (4) is the working area where you create QML components and \li \uicontrol Canvas (4) is the working area where you create QML components and
design applications. design applications.
\li \gui {Properties} pane (5) organizes the properties of the selected item. \li \uicontrol {Properties} pane (5) organizes the properties of the selected item.
You can change the properties also in the code editor. You can change the properties also in the code editor.
\li \gui {State} pane (6) displays the different states of the item. \li \uicontrol {State} pane (6) displays the different states of the item.
QML states typically describe user interface configurations, such as QML states typically describe user interface configurations, such as
the UI controls, their properties and behavior and the available the UI controls, their properties and behavior and the available
actions. actions.
@@ -84,14 +84,14 @@
\section1 Managing Item Hierarchy \section1 Managing Item Hierarchy
The \gui Navigator displays the items in the current QML file and their The \uicontrol Navigator displays the items in the current QML file and their
relationships. relationships.
Items (1) are listed in a tree structure, below their parent (2). Items (1) are listed in a tree structure, below their parent (2).
\image qmldesigner-navigator.png "Navigator" \image qmldesigner-navigator.png "Navigator"
You can select items in the \gui Navigator to edit their properties You can select items in the \uicontrol Navigator to edit their properties
in the \gui Properties pane. Items can access the properties of their in the \uicontrol Properties pane. Items can access the properties of their
parent item. To select items on the canvas, right-click an item, parent item. To select items on the canvas, right-click an item,
and select another type in the context menu. and select another type in the context menu.
@@ -109,16 +109,16 @@
Click the Click the
\inlineimage qmldesigner-show-hide-icon.png \inlineimage qmldesigner-show-hide-icon.png
icon to change the visibility of an item on the canvas. To change the icon to change the visibility of an item on the canvas. To change the
visibility of an item in the application, use the \gui Visibility visibility of an item in the application, use the \uicontrol Visibility
check box or the \gui Opacity field in the \gui Properties pane. If you set check box or the \uicontrol Opacity field in the \uicontrol Properties pane. If you set
\gui Opacity to 0, items are hidden, but you can still apply animation \uicontrol Opacity to 0, items are hidden, but you can still apply animation
to them. to them.
As all properties, visibility and opacity are inherited from the parent As all properties, visibility and opacity are inherited from the parent
item. To hide or show child items, edit the properties of the parent item. item. To hide or show child items, edit the properties of the parent item.
To view lists of files or projects, instead, select \gui {File System}, To view lists of files or projects, instead, select \uicontrol {File System},
\gui {Open Documents}, or \gui Projects in the menu. \uicontrol {Open Documents}, or \uicontrol Projects in the menu.
To view several types of content at a time, split the sidebar by clicking To view several types of content at a time, split the sidebar by clicking
\inlineimage qtcreator-splitbar.png \inlineimage qtcreator-splitbar.png
. .
@@ -133,9 +133,9 @@
up. up.
To change the stacking order of an item, right-click it on the canvas and To change the stacking order of an item, right-click it on the canvas and
select \gui {Stack (z)}. You can raise or lower the stack value of an item select \uicontrol {Stack (z)}. You can raise or lower the stack value of an item
or move the item to the front or back of all its siblings. To remove the or move the item to the front or back of all its siblings. To remove the
\c z property, select \gui {Reset z Property}. \c z property, select \uicontrol {Reset z Property}.
\section2 Switching Parent Items \section2 Switching Parent Items
@@ -148,7 +148,7 @@
key before you drag and drop the item into a new position. The topmost key before you drag and drop the item into a new position. The topmost
item under the cursor becomes the new parent of the item. item under the cursor becomes the new parent of the item.
You can change the parent of an item also in the \gui Navigator. You can change the parent of an item also in the \uicontrol Navigator.
Drag and drop the item to another position in the tree or use the arrow Drag and drop the item to another position in the tree or use the arrow
buttons (1) to move the item in the tree. buttons (1) to move the item in the tree.
@@ -156,10 +156,10 @@
\section1 QML Type Library \section1 QML Type Library
The \gui {Library} enables you to select QML types, UI components, and The \uicontrol {Library} enables you to select QML types, UI components, and
resources, as well as to manage imports. resources, as well as to manage imports.
\gui {QML Types} displays the QML types grouped by category: your own QML \uicontrol {QML Types} displays the QML types grouped by category: your own QML
components, basic types, layouts, positioner types, and views. components, basic types, layouts, positioner types, and views.
Sets of UI components with the look and feel of a particular mobile device Sets of UI components with the look and feel of a particular mobile device
@@ -167,34 +167,34 @@
Quick Controls, Dialogs, and Layouts are available for creating user Quick Controls, Dialogs, and Layouts are available for creating user
interfaces using Qt Quick 2.1. The components and controls are based on interfaces using Qt Quick 2.1. The components and controls are based on
standard QML types. To view the components and controls in the standard QML types. To view the components and controls in the
\gui {Library}, import the component sets in \gui Imports. \uicontrol {Library}, import the component sets in \uicontrol Imports.
The \gui {Qt Quick Application} wizards for a particular platform add the The \uicontrol {Qt Quick Application} wizards for a particular platform add the
import statements automatically. You can remove import statements in import statements automatically. You can remove import statements in
\gui Imports \uicontrol Imports
\image qmldesigner-qml-components.png "QML Components" \image qmldesigner-qml-components.png "QML Components"
\gui {Resources} displays the images and other files that you copy \uicontrol {Resources} displays the images and other files that you copy
to the project folder (to the same subfolder as the QML files). to the project folder (to the same subfolder as the QML files).
\section1 Specifying Item Properties \section1 Specifying Item Properties
The \gui Properties pane displays all the properties of the selected item. The \uicontrol Properties pane displays all the properties of the selected item.
The properties are grouped by type. The top part of the pane The properties are grouped by type. The top part of the pane
displays properties that are common to all QML types, such as displays properties that are common to all QML types, such as
position, size, and visibility. position, size, and visibility.
The bottom part of the pane displays properties that are specific to each The bottom part of the pane displays properties that are specific to each
QML type. For example, the following image displays the properties you QML type. For example, the following image displays the properties you
can set for \gui Rectangle (1) and \gui Text (2) items. can set for \uicontrol Rectangle (1) and \uicontrol Text (2) items.
\image qmldesigner-element-properties.png \image qmldesigner-element-properties.png
You can use a context-menu to reset some item properties. To reset the You can use a context-menu to reset some item properties. To reset the
position or size property of an item, right-click the item and select position or size property of an item, right-click the item and select
\gui {Edit > Reset Position} or \gui {Reset Size} in the context menu. To \uicontrol {Edit > Reset Position} or \uicontrol {Reset Size} in the context menu. To
set the visibility of the item, select \gui {Edit > Visibility}. set the visibility of the item, select \uicontrol {Edit > Visibility}.
For more information on the properties available for an item, press For more information on the properties available for an item, press
\key {F1}. \key {F1}.
@@ -212,12 +212,12 @@
When editing states, you can easily see which values are explicitly set in When editing states, you can easily see which values are explicitly set in
the current state and which values are derived from the base state. the current state and which values are derived from the base state.
The following images illustrate this. In the base state, the \gui Size (1) The following images illustrate this. In the base state, the \uicontrol Size (1)
and \gui Colors (2) values are explicitly set and highlighted. and \uicontrol Colors (2) values are explicitly set and highlighted.
\image qmldesigner-properties-explicit-base.png "Explicitly set properties" \image qmldesigner-properties-explicit-base.png "Explicitly set properties"
In \gui State1, only the color (1) is explicitly set and highlighted. In \uicontrol State1, only the color (1) is explicitly set and highlighted.
\image qmldesigner-properties-explicit-state1.png "Explicitly set properties" \image qmldesigner-properties-explicit-state1.png "Explicitly set properties"
@@ -253,7 +253,7 @@
\section2 Marking Text Items for Translation \section2 Marking Text Items for Translation
To support translators, mark each text item that should be translated. To support translators, mark each text item that should be translated.
In the \gui Properties pane, \gui Text field, select \gui tr (1). In the \uicontrol Properties pane, \uicontrol Text field, select \uicontrol tr (1).
\image qmldesigner-text-property-tr.png "Text properties" \image qmldesigner-text-property-tr.png "Text properties"
@@ -350,7 +350,7 @@
\section2 Building Transformations on Items \section2 Building Transformations on Items
The \gui Advanced pane allows you to configure advanced transformations, The \uicontrol Advanced pane allows you to configure advanced transformations,
such as rotation, scale, and translation. You can assign any number of such as rotation, scale, and translation. You can assign any number of
transformations to an item. Each transformation is applied in order, one at transformations to an item. Each transformation is applied in order, one at
a time. a time.
@@ -403,7 +403,7 @@
\endlist \endlist
The \gui State pane displays the different \l{State}{states} The \uicontrol State pane displays the different \l{State}{states}
of the component in the Qt Quick Designer. of the component in the Qt Quick Designer.
\image qmldesigner-transitions.png "State pane" \image qmldesigner-transitions.png "State pane"
@@ -414,7 +414,7 @@
you can change the position of an object on the canvas and then add animation you can change the position of an object on the canvas and then add animation
to the change between the states. to the change between the states.
You can preview the states in the \gui State pane and click them to switch You can preview the states in the \uicontrol State pane and click them to switch
between states on the canvas. between states on the canvas.
For more information on using states, see \l{Creating Screens}. For more information on using states, see \l{Creating Screens}.
@@ -438,13 +438,13 @@
Click the \inlineimage qmldesigner-snap-to-anchors-button.png Click the \inlineimage qmldesigner-snap-to-anchors-button.png
button to anchor the item to the items that you snap to. button to anchor the item to the items that you snap to.
Choose \gui {Tools > Options > Qt Quick > Qt Quick Designer} to specify Choose \uicontrol {Tools > Options > Qt Quick > Qt Quick Designer} to specify
settings for snapping. In the \gui {Parent item padding} field, specify the settings for snapping. In the \uicontrol {Parent item padding} field, specify the
distance in pixels between the parent item and the snapping lines. In the distance in pixels between the parent item and the snapping lines. In the
\gui {Sibling item spacing} field, specify the distance in pixels between \uicontrol {Sibling item spacing} field, specify the distance in pixels between
sibling items and the snapping lines. sibling items and the snapping lines.
The following image shows the snapping lines when \gui {Parent item padding} The following image shows the snapping lines when \uicontrol {Parent item padding}
is set to 5 pixels. is set to 5 pixels.
\image qmldesigner-snap-margins.png "Snapping lines on canvas" \image qmldesigner-snap-margins.png "Snapping lines on canvas"
@@ -476,18 +476,18 @@
bindings. bindings.
To experiment with different component sizes, enter values in the To experiment with different component sizes, enter values in the
\gui Height and \gui Width fields (1) on the canvas toolbar. The changes are \uicontrol Height and \uicontrol Width fields (1) on the canvas toolbar. The changes are
displayed in the \gui State pane (2) and on the canvas (3), but the property displayed in the \uicontrol State pane (2) and on the canvas (3), but the property
values are not changed permanently in the QML file. You can permanently values are not changed permanently in the QML file. You can permanently
change the property values in the \gui Properties pane (4). change the property values in the \uicontrol Properties pane (4).
\image qmldesigner-preview-size.png "Canvas width and height" \image qmldesigner-preview-size.png "Canvas width and height"
\section2 Specifying Canvas Size \section2 Specifying Canvas Size
To change the canvas size, select \gui {Tools > Options > Qt Quick To change the canvas size, select \uicontrol {Tools > Options > Qt Quick
> Qt Quick Designer} and > Qt Quick Designer} and
specify the canvas width and height in the \gui Canvas group. specify the canvas width and height in the \uicontrol Canvas group.
\section2 Refreshing the Canvas \section2 Refreshing the Canvas
@@ -499,6 +499,6 @@
To refresh the image on the canvas, press \key R or select To refresh the image on the canvas, press \key R or select
\inlineimage qmldesigner-reset-view.png \inlineimage qmldesigner-reset-view.png
(\gui {Reset View}). (\uicontrol {Reset View}).
*/ */

30
doc/src/qtquick/qtquick-exporting-qml.qdoc
View File

@@ -87,7 +87,7 @@
item, use top-level layer groups. item, use top-level layer groups.
\li To determine that some layers are not exported, hide them, and \li To determine that some layers are not exported, hide them, and
deselect the \gui {Export hidden} check box during exporting. deselect the \uicontrol {Export hidden} check box during exporting.
\li To make it easier to find the layers and layer groups after \li To make it easier to find the layers and layer groups after
exporting them, use descriptive names for them. exporting them, use descriptive names for them.
@@ -122,34 +122,34 @@
information about the script. information about the script.
\li Double-click the export script to add the export command to the \li Double-click the export script to add the export command to the
\gui Scripts menu. You can also copy the script file to the Adobe \uicontrol Scripts menu. You can also copy the script file to the Adobe
Photoshop scripts directory (typically, \c{\Presets\Scripts} in the Photoshop scripts directory (typically, \c{\Presets\Scripts} in the
Photoshop installation directory). Photoshop installation directory).
\li In Adobe Photoshop, choose \gui {File > Scripts > Export to QML} to \li In Adobe Photoshop, choose \uicontrol {File > Scripts > Export to QML} to
export the scene to a QML file. export the scene to a QML file.
\li In the \gui {Export Document to QML} dialog, enter a name and \li In the \uicontrol {Export Document to QML} dialog, enter a name and
location for the QML file. location for the QML file.
\li Select the \gui {Rasterize text} check box to export text layers as \li Select the \uicontrol {Rasterize text} check box to export text layers as
images, not as Text items. images, not as Text items.
\li Select the \gui {Group layers} check box to export each top-level \li Select the \uicontrol {Group layers} check box to export each top-level
group as a merged QML Image item. group as a merged QML Image item.
\li Select the \gui {Export hidden} check box to export hidden layers \li Select the \uicontrol {Export hidden} check box to export hidden layers
and to set their visibility property to hidden. and to set their visibility property to hidden.
\li Deselect the \gui {Export QML} check box if you have modified the \li Deselect the \uicontrol {Export QML} check box if you have modified the
QML document in \QC, but still want to re-export graphical assets. QML document in \QC, but still want to re-export graphical assets.
\li Click \gui Export. \li Click \uicontrol Export.
\endlist \endlist
The QML file is saved to the location that you specified. In \QC, choose The QML file is saved to the location that you specified. In \QC, choose
\gui {File > Open File or Project} to open the QML file. \uicontrol {File > Open File or Project} to open the QML file.
\note Existing files are replaced without warning. \note Existing files are replaced without warning.
@@ -186,18 +186,18 @@
On Linux, run the following command: \c {chmod u+rx} On Linux, run the following command: \c {chmod u+rx}
\li Restart GIMP to have the export command added to the \gui File menu. \li Restart GIMP to have the export command added to the \uicontrol File menu.
\li Choose \gui {File > Export to QML} to export the design to a QML \li Choose \uicontrol {File > Export to QML} to export the design to a QML
file. file.
\li In the \gui {Export Layers to a QML Document} dialog, enter a name \li In the \uicontrol {Export Layers to a QML Document} dialog, enter a name
and location for the QML file, and click \gui Export. and location for the QML file, and click \uicontrol Export.
\endlist \endlist
The QML file is saved to the location that you specified. In \QC, choose The QML file is saved to the location that you specified. In \QC, choose
\gui {File > Open File or Project} to open the QML file. \uicontrol {File > Open File or Project} to open the QML file.
\note Existing files are replaced without warning. \note Existing files are replaced without warning.

12
doc/src/qtquick/qtquick-modules-with-plugins.qdoc
View File

@@ -96,15 +96,15 @@
the box. the box.
To use an emulation layer that is built with the Qt To use an emulation layer that is built with the Qt
configured in the build and run kit for the project, select \gui Tools > configured in the build and run kit for the project, select \uicontrol Tools >
\gui Options > \gui {Qt Quick} > \gui {Qt Quick Designer} > \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer} >
\gui {Use QML emulation layer which is built by the selected Qt} radio button. \uicontrol {Use QML emulation layer which is built by the selected Qt} radio button.
\QC builds the emulation layer when you select the \gui Design mode. \QC builds the emulation layer when you select the \uicontrol Design mode.
A plugin should behave differently depending on whether it is run by the A plugin should behave differently depending on whether it is run by the
emulation layer or an application. For example, animations should not be run emulation layer or an application. For example, animations should not be run
in the \gui Design mode. You can use the value of the QML_PUPPET_MODE in the \uicontrol Design mode. You can use the value of the QML_PUPPET_MODE
environment variable to check whether the plugin is currently being run environment variable to check whether the plugin is currently being run
by an application or edited in the \gui Design mode. by an application or edited in the \uicontrol Design mode.
*/ */

8
doc/src/qtquick/qtquick-pathview-editor.qdoc
View File

@@ -48,17 +48,17 @@
control points to construct the curve. control points to construct the curve.
In addition, PathLine and PathQuad path objects are supported indirectly. In addition, PathLine and PathQuad path objects are supported indirectly.
To make a curve segment linear, select \gui {Make Curve Segment Straight} in To make a curve segment linear, select \uicontrol {Make Curve Segment Straight} in
the context menu. the context menu.
By default, the Path is closed, which means that its start and end points By default, the Path is closed, which means that its start and end points
are identical. To create separate start and end points for it, right-click are identical. To create separate start and end points for it, right-click
an edit point to open a context menu, and deselect \gui {Closed Path}. an edit point to open a context menu, and deselect \uicontrol {Closed Path}.
To add intermediary points to a curve segment, select \gui {Split Segment} To add intermediary points to a curve segment, select \uicontrol {Split Segment}
in the context menu. in the context menu.
In the \gui Properties pane, you can specify other properties for In the \uicontrol Properties pane, you can specify other properties for
the PathView. For example, what is the maximum distance from the path that the PathView. For example, what is the maximum distance from the path that
initiates mouse dragging and what is the rate at which a flick will initiates mouse dragging and what is the rate at which a flick will
decelerate. decelerate.

52
doc/src/qtquick/qtquick-screens.qdoc
View File

@@ -35,8 +35,8 @@
screens. Typically, the main qml file in a Qt Quick project specifies the screens. Typically, the main qml file in a Qt Quick project specifies the
main window of an application. main window of an application.
The QML files in the project folder are displayed in \gui {QML Components} The QML files in the project folder are displayed in \uicontrol {QML Components}
in the \gui Library. in the \uicontrol Library.
You can also use ready-made Qt Quick 1 Components (for Qt 4) to create You can also use ready-made Qt Quick 1 Components (for Qt 4) to create
screens with a native look and feel for a particular target platform. screens with a native look and feel for a particular target platform.
@@ -48,10 +48,10 @@
\list 1 \list 1
\li Drag and drop components from the \gui Library to the editor. \li Drag and drop components from the \uicontrol Library to the editor.
\li Select components in the \gui Navigator to edit their \li Select components in the \uicontrol Navigator to edit their
properties in the \gui Properties pane. properties in the \uicontrol Properties pane.
For example, you can anchor components to a position on the screen. For example, you can anchor components to a position on the screen.
@@ -76,7 +76,7 @@
When you add a GridView, ListView, or PathView, the ListModel and the When you add a GridView, ListView, or PathView, the ListModel and the
delegate component that creates an instance for each item in the model are delegate component that creates an instance for each item in the model are
added automatically. You can edit item properties added automatically. You can edit item properties
in the \gui Properties pane or in the \uicontrol Properties pane or
in the code editor. You can also replace the default model and in the code editor. You can also replace the default model and
delegate with other, more complex models and delegates in the code editor. delegate with other, more complex models and delegates in the code editor.
@@ -115,11 +115,11 @@
Property bindings are created implicitly in QML whenever a property is Property bindings are created implicitly in QML whenever a property is
assigned a JavaScript expression. To set JavaScript expressions as values of assigned a JavaScript expression. To set JavaScript expressions as values of
properties in \QMLD, click the circle icon next to a property to open a properties in \QMLD, click the circle icon next to a property to open a
context menu, and select \gui {Set Binding}. context menu, and select \uicontrol {Set Binding}.
\image qmldesigner-set-expression.png "Type properties context menu" \image qmldesigner-set-expression.png "Type properties context menu"
To remove bindings, select \gui Reset in the context menu. To remove bindings, select \uicontrol Reset in the context menu.
For more information on the JavaScript environment provided by QML, see For more information on the JavaScript environment provided by QML, see
\l{Integrating QML and JavaScript}. \l{Integrating QML and JavaScript}.
@@ -136,7 +136,7 @@
invisible \e anchor lines: top, bottom, left, right, fill, horizontal invisible \e anchor lines: top, bottom, left, right, fill, horizontal
center, vertical center, and baseline. center, vertical center, and baseline.
In the \gui Layout pane you can set anchors and margins for items. To set In the \uicontrol Layout pane you can set anchors and margins for items. To set
the anchors of an item, click the anchor buttons. You can combine the the anchors of an item, click the anchor buttons. You can combine the
top/bottom, left/right, and horizontal/vertical anchors to anchor items in top/bottom, left/right, and horizontal/vertical anchors to anchor items in
the corners of the parent item or center them horizontally or vertically the corners of the parent item or center them horizontally or vertically
@@ -149,7 +149,7 @@
For performance reasons, you can only anchor an item to its siblings and For performance reasons, you can only anchor an item to its siblings and
direct parent. By default, an item is anchored to its parent when you direct parent. By default, an item is anchored to its parent when you
use the anchor buttons. Select a sibling of the item in the \gui Target use the anchor buttons. Select a sibling of the item in the \uicontrol Target
field to anchor to it, instead. field to anchor to it, instead.
Arbitrary anchoring is not supported. For example, you cannot specify: Arbitrary anchoring is not supported. For example, you cannot specify:
@@ -159,12 +159,12 @@
to the opposite side: \c {anchor.left: sibling.right}. This allows you to keep to the opposite side: \c {anchor.left: sibling.right}. This allows you to keep
sibling items together. sibling items together.
In the following image, \gui{Rectangle 2} is anchored to \gui{Rectangle 1} In the following image, \uicontrol{Rectangle 2} is anchored to \uicontrol{Rectangle 1}
on its left and to the bottom of its parent. on its left and to the bottom of its parent.
\image qmldesigner-anchors.png "Anchoring sibling items" \image qmldesigner-anchors.png "Anchoring sibling items"
The anchors for \gui{Rectangle 2} are specified as follows in code: The anchors for \uicontrol{Rectangle 2} are specified as follows in code:
\qml \qml
Rectangle { Rectangle {
@@ -207,7 +207,7 @@
\endlist \endlist
To lay out several items in a Column, Row, Grid, or Flow, select To lay out several items in a Column, Row, Grid, or Flow, select
the items on the canvas, and then select \gui Layout in the context the items on the canvas, and then select \uicontrol Layout in the context
menu. menu.
\section2 Using Layouts \section2 Using Layouts
@@ -222,7 +222,7 @@
\list \list
\li \l{Layout} provides attached properties for items pushed onto a \li \l{Layout} provides attached properties for items pushed onto a
\gui {Column Layout}, \gui {Row Layout}, or \gui {Grid Layout}. \uicontrol {Column Layout}, \uicontrol {Row Layout}, or \uicontrol {Grid Layout}.
\li ColumnLayout provides a grid layout with only one column. \li ColumnLayout provides a grid layout with only one column.
@@ -233,14 +233,14 @@
\endlist \endlist
To lay out several items in a \gui {Column Layout}, \gui {Row Layout}, or To lay out several items in a \uicontrol {Column Layout}, \uicontrol {Row Layout}, or
\gui {Grid Layout}, select the items on the canvas, and then select \uicontrol {Grid Layout}, select the items on the canvas, and then select
\gui Layout in the context menu. \uicontrol Layout in the context menu.
To make an item within a layout as wide as possible while respecting the To make an item within a layout as wide as possible while respecting the
given constraints, select the item on the canvas and then select given constraints, select the item on the canvas and then select
\gui Layout > \gui {Fill Width} in the context menu. To make the item as \uicontrol Layout > \uicontrol {Fill Width} in the context menu. To make the item as
high as possible, select \gui {Fill Height}. high as possible, select \uicontrol {Fill Height}.
\section2 Using Split Views \section2 Using Split Views
@@ -257,7 +257,7 @@
controls, their properties and behavior and the available actions. For controls, their properties and behavior and the available actions. For
example, you can use states to create two screens. example, you can use states to create two screens.
To add states, click the empty slot in the \gui States pane. Then modify the To add states, click the empty slot in the \uicontrol States pane. Then modify the
new state in the visual editor. new state in the visual editor.
\image qmldesigner-states.png "States pane" \image qmldesigner-states.png "States pane"
@@ -297,11 +297,11 @@
\inlineimage qmldesigner-show-hide-icon.png \inlineimage qmldesigner-show-hide-icon.png
icon to hide items on the canvas that are not part of a screen. icon to hide items on the canvas that are not part of a screen.
\li In the \gui States pane, click the empty slot to create a new state \li In the \uicontrol States pane, click the empty slot to create a new state
and give it a name. For example, \c Normal. and give it a name. For example, \c Normal.
\li In the \gui Properties pane (2), deselect the \gui Visibility check box \li In the \uicontrol Properties pane (2), deselect the \uicontrol Visibility check box
or set \gui Opacity to 0 for each item that is not needed in this or set \uicontrol Opacity to 0 for each item that is not needed in this
view. If you specify the setting for the parent item, all child view. If you specify the setting for the parent item, all child
items inherit it and are also hidden. items inherit it and are also hidden.
@@ -394,7 +394,7 @@
Not visible in the item library in 3.2. Not visible in the item library in 3.2.
\li StatusBar contains status information in your application. It \li StatusBar contains status information in your application. It
does not provide a layout of its own, but requires you to position does not provide a layout of its own, but requires you to position
its contents, for instance by creating a \gui {Row Layout}. its contents, for instance by creating a \uicontrol {Row Layout}.
\endomit \endomit
\li TextArea displays multiple lines of editable formatted text. \li TextArea displays multiple lines of editable formatted text.
@@ -406,11 +406,11 @@
\li ToolBar provides styling for ToolButton as well as other controls \li ToolBar provides styling for ToolButton as well as other controls
that it can contain. However, it does not provide a layout of its that it can contain. However, it does not provide a layout of its
own, but requires you to position its contents, for instance by own, but requires you to position its contents, for instance by
creating a \gui {Row Layout}. creating a \uicontrol {Row Layout}.
\endomit \endomit
\li ToolButton provides a button that is functionally similar to \li ToolButton provides a button that is functionally similar to
\gui Button, but that looks more suitable on a \gui {Tool Bar}. \uicontrol Button, but that looks more suitable on a \uicontrol {Tool Bar}.
\endlist \endlist

6
doc/src/qtquick/qtquick-toolbars.qdoc
View File

@@ -36,13 +36,13 @@
. Select the icon to open the toolbar. . Select the icon to open the toolbar.
To open toolbars immediately when you select a QML type, select To open toolbars immediately when you select a QML type, select
\gui{Tools > Options > Qt Quick > Qt Quick Toolbar > Always show Qt Quick \uicontrol{Tools > Options > Qt Quick > Qt Quick Toolbar > Always show Qt Quick
Toolbar}. Toolbar}.
Drag the toolbar to pin it to another location. Select Drag the toolbar to pin it to another location. Select
\inlineimage qml-toolbar-pin.png \inlineimage qml-toolbar-pin.png
to unpin the toolbar and move it to its default location. To pin toolbars to unpin the toolbar and move it to its default location. To pin toolbars
by default, select \gui{Tools > Options > Qt Quick > Qt Quick Toolbar by default, select \uicontrol{Tools > Options > Qt Quick > Qt Quick Toolbar
> Pin Quick Toolbar}. > Pin Quick Toolbar}.
\section1 Previewing Images \section1 Previewing Images
@@ -73,7 +73,7 @@
\image qml-toolbar-text.png "Qt Quick Toolbar for text" \image qml-toolbar-text.png "Qt Quick Toolbar for text"
By default, font size is specified as pixels. To use points, instead, By default, font size is specified as pixels. To use points, instead,
change \gui px to \gui pt in the size field. change \uicontrol px to \uicontrol pt in the size field.
\section1 Previewing Animation \section1 Previewing Animation

6
doc/src/qtquick/qtquick-ui-forms.qdoc
View File

@@ -33,7 +33,7 @@
You can use \QC wizards to create UI forms that have the filename extension You can use \QC wizards to create UI forms that have the filename extension
\e .ui.qml. The UI forms contain a purely declarative subset of the QML \e .ui.qml. The UI forms contain a purely declarative subset of the QML
language. It is recommended that you edit the forms in the \gui Design mode. language. It is recommended that you edit the forms in the \uicontrol Design mode.
\QC enforces the use of the supported QML features by displaying error \QC enforces the use of the supported QML features by displaying error
messages. messages.
@@ -64,7 +64,7 @@
\section1 Using Qt Quick UI Forms \section1 Using Qt Quick UI Forms
You can edit the forms in the \gui Design mode. Items that are supposed to You can edit the forms in the \uicontrol Design mode. Items that are supposed to
be used in QML code have to be exported as properties: be used in QML code have to be exported as properties:
\code \code
@@ -85,7 +85,7 @@
The property alias exports the button to the QML code that uses the form. The property alias exports the button to the QML code that uses the form.
You can use the You can use the
\inlineimage qmldesigner-export-item-button.png \inlineimage qmldesigner-export-item-button.png
(\gui Export) button in the \gui Navigator to export an item as a property (\uicontrol Export) button in the \uicontrol Navigator to export an item as a property
(commercial only): (commercial only):
\image qmldesigner-export-item.png \image qmldesigner-export-item.png

104
doc/src/widgets/qtdesigner-app-tutorial.qdoc
View File

@@ -41,59 +41,59 @@
\list 1 \list 1
\li Select \gui{File > New File or Project > Application > Qt Widgets \li Select \uicontrol{File > New File or Project > Application > Qt Widgets
Application > Choose}. Application > Choose}.
\image qtcreator-new-qt-gui-application.png "New File or Project dialog" \image qtcreator-new-qt-gui-application.png "New File or Project dialog"
The \gui{Introduction and Project Location} dialog opens. The \uicontrol{Introduction and Project Location} dialog opens.
\image qtcreator-intro-and-location-qt-gui.png "Introduction and Project Location dialog" \image qtcreator-intro-and-location-qt-gui.png "Introduction and Project Location dialog"
\li In the \gui{Name} field, type \b {TextFinder}. \li In the \uicontrol{Name} field, type \b {TextFinder}.
\li In the \gui {Create in} field, enter the path for the project files. \li In the \uicontrol {Create in} field, enter the path for the project files.
For example, \c {C:\Qt\examples}, and then click \gui{Next} (on For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (on
Windows and Linux) or \gui Continue (on OS X). Windows and Linux) or \uicontrol Continue (on OS X).
The \gui {Kit Selection} dialog opens. The \uicontrol {Kit Selection} dialog opens.
\image qtcreator-new-project-qt-versions-qt-gui.png "Kit Selection dialog" \image qtcreator-new-project-qt-versions-qt-gui.png "Kit Selection dialog"
\li Select build and run \l{glossary-buildandrun-kit}{kits} for your project, \li Select build and run \l{glossary-buildandrun-kit}{kits} for your project,
and click \gui Next or \gui Continue. and click \uicontrol Next or \uicontrol Continue.
\note If only one kit is specified in \gui Tools > \gui Options > \note If only one kit is specified in \uicontrol Tools > \uicontrol Options >
\gui {Build & Run} > \gui Kits (on Windows and Linux) or in \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux) or in
\gui {Qt Creator} > \gui Preferences \gui {Build & Run} > \gui Kits \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} > \uicontrol Kits
(on OS X), this dialog is skipped. (on OS X), this dialog is skipped.
The \gui{Class Information} dialog opens. The \uicontrol{Class Information} dialog opens.
\image qtcreator-class-info-qt-gui.png "Class Information dialog" \image qtcreator-class-info-qt-gui.png "Class Information dialog"
\li In the \gui{Class name} field, type \b {TextFinder} as the class \li In the \uicontrol{Class name} field, type \b {TextFinder} as the class
name. name.
\li In the \gui{Base class} list, select \b {QWidget} as the base \li In the \uicontrol{Base class} list, select \b {QWidget} as the base
class type. class type.
\note The \gui{Header file}, \gui{Source file} and \gui{Form file} \note The \uicontrol{Header file}, \uicontrol{Source file} and \uicontrol{Form file}
fields are automatically updated to match the name of the class. fields are automatically updated to match the name of the class.
\li Click \gui Next or \gui Continue. \li Click \uicontrol Next or \uicontrol Continue.
The \gui{Project Management} dialog opens. The \uicontrol{Project Management} dialog opens.
\image qtcreator-new-project-summary-qt-gui.png "Project Management dialog" \image qtcreator-new-project-summary-qt-gui.png "Project Management dialog"
\li Review the project settings, and click \gui{Finish} (on Windows and \li Review the project settings, and click \uicontrol{Finish} (on Windows and
Linux) or \gui Done (on OS X) to create the project. Linux) or \uicontrol Done (on OS X) to create the project.
\endlist \endlist
\note The project opens in the \gui Edit mode, and these instructions are \note The project opens in the \uicontrol Edit mode, and these instructions are
hidden. To return to these instructions, open the \gui Help mode. hidden. To return to these instructions, open the \uicontrol Help mode.
The TextFinder project now contains the following files: The TextFinder project now contains the following files:
@@ -123,56 +123,56 @@
\list 1 \list 1
\li In the \gui{Editor} mode, double-click the textfinder.ui file in the \li In the \uicontrol{Editor} mode, double-click the textfinder.ui file in the
\gui{Projects} view to launch the integrated \QD. \uicontrol{Projects} view to launch the integrated \QD.
\li Drag and drop the following widgets to the form: \li Drag and drop the following widgets to the form:
\list \list
\li \gui{Label} (QLabel) \li \uicontrol{Label} (QLabel)
\li \gui{Line Edit} (QLineEdit) \li \uicontrol{Line Edit} (QLineEdit)
\li \gui{Push Button} (QPushButton) \li \uicontrol{Push Button} (QPushButton)
\endlist \endlist
\image qtcreator-textfinder-ui-widgets.png "Adding widgets to Text Finder UI" \image qtcreator-textfinder-ui-widgets.png "Adding widgets to Text Finder UI"
\note To easily locate the widgets, use the search box at the top of the \note To easily locate the widgets, use the search box at the top of the
\gui Sidebar. For example, to find the \gui Label widget, start typing \uicontrol Sidebar. For example, to find the \uicontrol Label widget, start typing
the word \b label. the word \b label.
\image qtcreator-texfinder-filter.png "Filter field" \image qtcreator-texfinder-filter.png "Filter field"
\li Double-click the \gui{Label} widget and enter the text \li Double-click the \uicontrol{Label} widget and enter the text
\b{Keyword}. \b{Keyword}.
\li Double-click the \gui{Push Button} widget and enter the text \li Double-click the \uicontrol{Push Button} widget and enter the text
\b{Find}. \b{Find}.
\li In the \gui Properties pane, change the \gui objectName to \li In the \uicontrol Properties pane, change the \uicontrol objectName to
\b findButton. \b findButton.
\image qtcreator-textfinder-objectname.png "Changing object names" \image qtcreator-textfinder-objectname.png "Changing object names"
\li Press \key {Ctrl+A} (or \key {Cmd+A}) to select the widgets and \li Press \key {Ctrl+A} (or \key {Cmd+A}) to select the widgets and
click \gui{Lay out Horizontally} (or press \gui{Ctrl+H} on Linux or click \uicontrol{Lay out Horizontally} (or press \uicontrol{Ctrl+H} on Linux or
Windows or \key {Ctrl+Shift+H} on OS X) to apply a horizontal Windows or \key {Ctrl+Shift+H} on OS X) to apply a horizontal
layout (QHBoxLayout). layout (QHBoxLayout).
\image qtcreator-texfinder-ui-horizontal-layout.png "Applying horizontal layout" \image qtcreator-texfinder-ui-horizontal-layout.png "Applying horizontal layout"
\li Drag and drop a \gui{Text Edit} widget (QTextEdit) to the form. \li Drag and drop a \uicontrol{Text Edit} widget (QTextEdit) to the form.
\li Select the screen area and click \gui{Lay out Vertically} (or press \li Select the screen area and click \uicontrol{Lay out Vertically} (or press
\gui{Ctrl+L}) to apply a vertical layout (QVBoxLayout). \uicontrol{Ctrl+L}) to apply a vertical layout (QVBoxLayout).
\image qtcreator-textfinder-ui.png "Text Finder UI" \image qtcreator-textfinder-ui.png "Text Finder UI"
Applying the horizontal and vertical layouts ensures that the Applying the horizontal and vertical layouts ensures that the
application UI scales to different screen sizes. application UI scales to different screen sizes.
\li To call a find function when users press the \gui Find button, you \li To call a find function when users press the \uicontrol Find button, you
use the Qt signals and slots mechanism. A signal is emitted when a use the Qt signals and slots mechanism. A signal is emitted when a
particular event occurs and a slot is a function that is called in particular event occurs and a slot is a function that is called in
response to a particular signal. Qt widgets have predefined signals response to a particular signal. Qt widgets have predefined signals
@@ -181,10 +181,10 @@
\list \list
\li Right-click the \gui Find button to open a context-menu. \li Right-click the \uicontrol Find button to open a context-menu.
\li Select \gui {Go to Slot > clicked()}, and then select \li Select \uicontrol {Go to Slot > clicked()}, and then select
\gui OK. \uicontrol OK.
A private slot, \c{on_findButton_clicked()}, is added to the A private slot, \c{on_findButton_clicked()}, is added to the
header file, textfinder.h and a private function, header file, textfinder.h and a private function,
@@ -193,7 +193,7 @@
\endlist \endlist
\li Press \gui{Ctrl+S} (or \key {Cmd+S}) to save your changes. \li Press \uicontrol{Ctrl+S} (or \key {Cmd+S}) to save your changes.
\endlist \endlist
@@ -209,7 +209,7 @@
\list 1 \list 1
\li In the \gui{Projects} pane in the \gui {Edit view}, double-click the \li In the \uicontrol{Projects} pane in the \uicontrol {Edit view}, double-click the
\c{textfinder.h} file to open it for editing. \c{textfinder.h} file to open it for editing.
\li Add a private function to the \c{private} section, after the \li Add a private function to the \c{private} section, after the
@@ -227,7 +227,7 @@
\list 1 \list 1
\li In the \gui{Projects} pane in the \gui Edit view, double-click the \li In the \uicontrol{Projects} pane in the \uicontrol Edit view, double-click the
textfinder.cpp file to open it for editing. textfinder.cpp file to open it for editing.
\li Add code to load a text file using QFile, read it with QTextStream, \li Add code to load a text file using QFile, read it with QTextStream,
@@ -275,35 +275,35 @@
\list 1 \list 1
\li Select \gui{File > New File or Project > Qt > Qt Resource File > \li Select \uicontrol{File > New File or Project > Qt > Qt Resource File >
Choose}. Choose}.
\image qtcreator-add-resource-wizard.png "New File or Project dialog" \image qtcreator-add-resource-wizard.png "New File or Project dialog"
The \gui {Choose the Location} dialog opens. The \uicontrol {Choose the Location} dialog opens.
\image qtcreator-add-resource-wizard2.png "Choose the Location dialog" \image qtcreator-add-resource-wizard2.png "Choose the Location dialog"
\li In the \gui{Name} field, enter \b{textfinder}. \li In the \uicontrol{Name} field, enter \b{textfinder}.
\li In the \gui{Path} field, enter \c{C:\Qt\examples\TextFinder}, \li In the \uicontrol{Path} field, enter \c{C:\Qt\examples\TextFinder},
and click \gui Next or \gui Continue. and click \uicontrol Next or \uicontrol Continue.
The \gui{Project Management} dialog opens. The \uicontrol{Project Management} dialog opens.
\image qtcreator-add-resource-wizard3.png "Project Management dialog" \image qtcreator-add-resource-wizard3.png "Project Management dialog"
\li In the \gui{Add to project} field, select \b{TextFinder.pro} \li In the \uicontrol{Add to project} field, select \b{TextFinder.pro}
and click \gui{Finish} or \gui Done to open the file in the code and click \uicontrol{Finish} or \uicontrol Done to open the file in the code
editor. editor.
\li Select \gui{Add > Add Prefix}. \li Select \uicontrol{Add > Add Prefix}.
\li In the \gui{Prefix} field, replace the default prefix with a slash \li In the \uicontrol{Prefix} field, replace the default prefix with a slash
(/). (/).
\li Select \gui{Add > Add Files}, to locate and add input.txt. \li Select \uicontrol{Add > Add Files}, to locate and add input.txt.
\image qtcreator-add-resource.png "Editing resource files" \image qtcreator-add-resource.png "Editing resource files"

38
doc/src/widgets/qtdesigner-overview.qdoc
View File

@@ -30,7 +30,7 @@
\title Developing Widget Based Applications \title Developing Widget Based Applications
\QC automatically opens all .ui files in the integrated \QD, in \gui Design \QC automatically opens all .ui files in the integrated \QD, in \uicontrol Design
mode. mode.
\image qtcreator-formedit.png \image qtcreator-formedit.png
@@ -42,22 +42,22 @@
\section1 Code Editor Integration \section1 Code Editor Integration
To switch between forms (\gui Design mode) and code (\gui Edit mode), To switch between forms (\uicontrol Design mode) and code (\uicontrol Edit mode),
press \key Shift+F4. press \key Shift+F4.
You can use \QC to create stub implementations of slot functions. In the You can use \QC to create stub implementations of slot functions. In the
\gui Design mode, right-click a widget to open a context menu, and then \uicontrol Design mode, right-click a widget to open a context menu, and then
select \gui {Go to Slot}. Select a signal in the list to go to an existing select \uicontrol {Go to Slot}. Select a signal in the list to go to an existing
slot function or to create a new slot function. slot function or to create a new slot function.
\section1 Managing Image Resources \section1 Managing Image Resources
In standalone \QD, image resources are created using the built-in In standalone \QD, image resources are created using the built-in
\gui {Resource Editor}. In \QC, .ui files are usually part of a project, \uicontrol {Resource Editor}. In \QC, .ui files are usually part of a project,
which may contain several resource files (.qrc). They are created and which may contain several resource files (.qrc). They are created and
maintained by using the \QC Resource Editor. The \QD \gui {Resource Editor} maintained by using the \QC Resource Editor. The \QD \uicontrol {Resource Editor}
is de-activated and the image resources are displayed in the \QD is de-activated and the image resources are displayed in the \QD
\gui {Resource Browser}. \uicontrol {Resource Browser}.
\section1 Specifying Settings for Qt Designer \section1 Specifying Settings for Qt Designer
@@ -67,23 +67,23 @@
\list \list
\li Select \gui Tools > \gui Options > \gui Designer. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Designer.
\li Specify settins for generating classes and code in \gui {Class \li Specify settins for generating classes and code in \uicontrol {Class
Generation}. Generation}.
\li Specify embedded device profiles, that determine style, font, and \li Specify embedded device profiles, that determine style, font, and
screen resolution, for example, in \gui{Embedded Design}. screen resolution, for example, in \uicontrol{Embedded Design}.
\li Specify settings for the grid and previewing forms in \gui Forms. \li Specify settings for the grid and previewing forms in \uicontrol Forms.
\li Specify an additional folder for saving templates in \gui{Template \li Specify an additional folder for saving templates in \uicontrol{Template
Paths}. Paths}.
\endlist \endlist
To preview the settings, select \gui Tools > \gui{Form Editor} > To preview the settings, select \uicontrol Tools > \uicontrol{Form Editor} >
\gui Preview, or press \key Alt+Shift+R. \uicontrol Preview, or press \key Alt+Shift+R.
\section1 Previewing Forms Using Device Skins \section1 Previewing Forms Using Device Skins
@@ -95,15 +95,15 @@
\list 1 \list 1
\li Select \gui Tools > \gui Options > \gui Designer. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Designer.
\li Select the \gui{Print/Preview Configuration} check box. \li Select the \uicontrol{Print/Preview Configuration} check box.
\li In the \gui {Device skin} field, select a device skin. \li In the \uicontrol {Device skin} field, select a device skin.
\li When the form is open in \gui Design mode, press \key Alt+Shift+R. \li When the form is open in \uicontrol Design mode, press \key Alt+Shift+R.
\li To end the preview, right-click the skin and select \gui Close in \li To end the preview, right-click the skin and select \uicontrol Close in
the context menu. the context menu.
\endlist \endlist

6
doc/src/widgets/qtdesigner-plugins.qdoc
View File

@@ -55,13 +55,13 @@
OS X, see \l{Configuring Qt Designer Plugins on OS X}. OS X, see \l{Configuring Qt Designer Plugins on OS X}.
To check which plugins To check which plugins
were loaded successfully and which failed, choose \gui{Tools > Form Editor > were loaded successfully and which failed, choose \uicontrol{Tools > Form Editor >
About Qt Designer Plugins}. About Qt Designer Plugins}.
The standalone \QD is part of the Qt library used for building projects, The standalone \QD is part of the Qt library used for building projects,
located under \c {%SDK%\qt}. Therefore, it fetches plugins from the located under \c {%SDK%\qt}. Therefore, it fetches plugins from the
following folder: \c {%SDK%\qt\plugins\designer}. To check which plugins following folder: \c {%SDK%\qt\plugins\designer}. To check which plugins
were loaded successfully and which failed, choose \gui{Help > were loaded successfully and which failed, choose \uicontrol{Help >
About Plugins}. About Plugins}.
\section2 Configuring Qt Designer Plugins on OS X \section2 Configuring Qt Designer Plugins on OS X
@@ -133,7 +133,7 @@
building applications is configured and built to use the MinGW/g++ compiler. building applications is configured and built to use the MinGW/g++ compiler.
Plugins built by using this version of Qt cannot be loaded by \QC because Plugins built by using this version of Qt cannot be loaded by \QC because
the build-keys do not match. The plugins can only be used in the standalone the build-keys do not match. The plugins can only be used in the standalone
version of \QD. Choose \gui{Help > About \QC} to check the Qt version \QC version of \QD. Choose \uicontrol{Help > About \QC} to check the Qt version \QC
was built with. was built with.
To use \QD plugins that were built for the shipped Qt version, make sure To use \QD plugins that were built for the shipped Qt version, make sure

8
doc/src/winrt/creator-winrt.qdoc
View File

@@ -41,8 +41,8 @@
\list 1 \list 1
\li Select \gui Help > \gui {About Plugins} > \gui {Device Support} > \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {Device Support} >
\gui WinRT to enable the experimental Windows Runtime plugin. \uicontrol WinRT to enable the experimental Windows Runtime plugin.
\li Restart \QC to be able to use the plugin. \li Restart \QC to be able to use the plugin.
@@ -53,14 +53,14 @@
\li Open a project for an application you want to develop for the \li Open a project for an application you want to develop for the
device. device.
\li Select \gui Projects > \gui {Build & Run} > \gui {Add Kit} to \li Select \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol {Add Kit} to
add a kit for building and running applications on Windows add a kit for building and running applications on Windows
Runtime devices (the local computer, for now), Windows Phones, Runtime devices (the local computer, for now), Windows Phones,
or the Windows Phone emulator. or the Windows Phone emulator.
\endlist \endlist
\li Select \gui Run to specify run settings. \li Select \uicontrol Run to specify run settings.
Usually, you can use the default settings. Usually, you can use the default settings.