diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2014-12-11 15:43:19 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2014-12-12 10:26:59 +0100 |
| commit | e1fbeedcd4e47cb83d00173907607236b06c8ff6 (patch) | |
| tree | d34c4961794c6406d05f36aacf215da3ce179a27 /doc | |
| parent | c9696aa6f4e1a737e3445702b138b2c0a2bd85ce (diff) | |
| download | qt-creator-e1fbeedcd4e47cb83d00173907607236b06c8ff6.tar.gz | |
Doc: use \uicontrol command instead of \gui macro
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'doc')
97 files changed, 1955 insertions, 1876 deletions
diff --git a/doc/src/analyze/creator-analyze.qdoc b/doc/src/analyze/creator-analyze.qdoc index 899a7b45b1..0ec5c57b36 100644 --- a/doc/src/analyze/creator-analyze.qdoc +++ b/doc/src/analyze/creator-analyze.qdoc @@ -30,20 +30,20 @@ \title Analyzing Code - You can use the code analysis tools in the \gui Analyze mode. To switch to - \gui Analyze mode, select \gui Analyze in the mode selector, or select the - \gui {Analyze} menu and then select a tool. When you are in the - \gui Analyze mode, you can switch between tools by selecting them in the + You can use the code analysis tools in the \uicontrol Analyze mode. To switch to + \uicontrol Analyze mode, select \uicontrol Analyze in the mode selector, or + select the \uicontrol {Analyze} menu and then select a tool. When you are in the + \uicontrol Analyze mode, you can switch between tools by selecting them in the menu on the toolbar. \image qtcreator-analyze-menu.png "Analyze mode menu" - You can drag and drop the views in the \gui Analyze mode to new positions + You can drag and drop the views in the \uicontrol Analyze mode to new positions on the screen. The size and position of views are saved for future - sessions. Select \gui {Window > Views > Reset to Default Layout} to reset + sessions. Select \uicontrol {Window > Views > Reset to Default Layout} to reset the views to their original sizes and positions. - You can use the following code analysis tools in the \gui Analyze mode: + You can use the following code analysis tools in the \uicontrol Analyze mode: \list diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc index 6d6f7cfdbf..2055d71ad2 100644 --- a/doc/src/analyze/creator-clang-static-analyzer.qdoc +++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc @@ -48,14 +48,15 @@ \list 1 - \li Select \gui Help > \gui {About Plugins} > \gui {Code Analyzer} > - \gui {Clang Static Analyzer} to enable the experimental plugin. + \li Select \uicontrol Help > \uicontrol {About Plugins} > + \uicontrol {Code Analyzer} > \uicontrol {Clang Static Analyzer} to + enable the experimental plugin. \li Restart \QC to be able to use the plugin. - \li Select \gui Tools > \gui Options > \gui Analyzer > - \gui {Clang Static Analyzer} to check that the path to the Clang - executable is set correctly in the \gui {Clang executable} field. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer > + \uicontrol {Clang Static Analyzer} to check that the path to the Clang + executable is set correctly in the \uicontrol {Clang executable} field. \image qtcreator-clang-static-analyzer-options.png @@ -65,11 +66,11 @@ \list 1 - \li Select \gui Analyze > \gui {Clang Static Analyzer}. + \li Select \uicontrol Analyze > \uicontrol {Clang Static Analyzer}. \li Select the \inlineimage qtcreator-analyze-start-button.png - (\gui Start) button to run the Clang Static Analyzer on the + (\uicontrol Start) button to run the Clang Static Analyzer on the application. \endlist diff --git a/doc/src/analyze/creator-valgrind-overview.qdoc b/doc/src/analyze/creator-valgrind-overview.qdoc index 1c8f268856..3e1c358a1e 100644 --- a/doc/src/analyze/creator-valgrind-overview.qdoc +++ b/doc/src/analyze/creator-valgrind-overview.qdoc @@ -52,12 +52,12 @@ For more information about analyzing applications for which you do not have a project, see \l{Running Valgrind Tools on External Applications}. - To stop the currently running analyzer, select \gui {Analyze + To stop the currently running analyzer, select \uicontrol {Analyze > Stop}. - To select options for the Valgrind tools, select \gui {Tools > Options > + To select options for the Valgrind tools, select \uicontrol {Tools > Options > Analyzer}. You can override the general settings for each project in the - \gui {Run Settings} for the project. + \uicontrol {Run Settings} for the project. The following sections describe how to use the Valgrind tools: diff --git a/doc/src/analyze/creator-valgrind.qdoc b/doc/src/analyze/creator-valgrind.qdoc index d01229b8a3..51127a636a 100644 --- a/doc/src/analyze/creator-valgrind.qdoc +++ b/doc/src/analyze/creator-valgrind.qdoc @@ -44,9 +44,9 @@ \list 1 - \li In the \gui Projects mode, select a debug build configuration. + \li In the \uicontrol Projects mode, select a debug build configuration. - \li Select \gui Analyze > \gui {Valgrind Memory Analyzer}. + \li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer}. \li Select the \inlineimage qtcreator-analyze-start-button.png "Start button" @@ -57,14 +57,14 @@ \li Select the \inlineimage qtcreator-debug-button-stop.png "Stop button" button to view the results of the analysis in the - \gui {Analysis} view. + \uicontrol {Analysis} view. \endlist While the application is running, Memcheck checks all reads and writes of memory and intercepts calls that allocate or free memory or create or delete memory blocks. When you stop Memcheck, it displays the results in - the \gui Analysis view. Click a line to view where a memory leak + the \uicontrol Analysis view. Click a line to view where a memory leak occurred and a stack trace that shows what caused it. \image analyzer-issues.png "Analysis view" @@ -83,22 +83,22 @@ Stack traces can get quite large and confusing, and therefore, reading them from the bottom up can help. If the stack trace is not big enough or it is - too big, select \gui {Tools > Options > Analyzer}. - Define the length of the stack trace in the \gui {Backtrace frame count} + too big, select \uicontrol {Tools > Options > Analyzer}. + Define the length of the stack trace in the \uicontrol {Backtrace frame count} field. \image qtcreator-valgrind-memcheck-options.png "Memory Analysis options" Memcheck also reports uses of uninitialised values, most commonly with the - message \gui {Conditional jump or move depends on uninitialised value(s).} - To determine the root cause of these errors, the \gui {Track origins of + message \uicontrol {Conditional jump or move depends on uninitialised value(s).} + To determine the root cause of these errors, the \uicontrol {Track origins of uninitialized memory} check box is selected by default. You can deselect it to make Memcheck run faster. Memcheck searches for memory leaks when the client application finishes. To - view the amount of leaks that occurred, select \gui {Summary Only} in the - \gui {Check for leaks on finish} field. To also view details of each leak, - select \gui Full. + view the amount of leaks that occurred, select \uicontrol {Summary Only} in the + \uicontrol {Check for leaks on finish} field. To also view details of each leak, + select \uicontrol Full. \section2 Showing Reachable and Indirectly Lost Blocks @@ -109,7 +109,7 @@ root node are indirectly lost. By default, Memcheck does not report reachable and indirectly lost blocks. - To have them reported, select the \gui {Show reachable and indirectly lost + To have them reported, select the \uicontrol {Show reachable and indirectly lost blocks}. \section2 Suppressing Errors @@ -122,7 +122,7 @@ You can write your own suppression files if parts of your project contain errors you cannot fix and you do not want to be reminded of them. Click - \gui Add in the \gui {Memory Analysis} dialog to add the suppression files. + \uicontrol Add in the \uicontrol {Memory Analysis} dialog to add the suppression files. For more information about writing suppression files, see \l{http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress} {Suppressing Errors} in the Valgrind documentation. @@ -152,9 +152,9 @@ \list 1 - \li In the \gui Projects mode, select a release build configuration. + \li In the \uicontrol Projects mode, select a release build configuration. - \li Select \gui Analyze > \gui {Valgrind Function Profiler}. + \li Select \uicontrol Analyze > \uicontrol {Valgrind Function Profiler}. \li Select the \inlineimage qtcreator-analyze-start-button.png "Start button" @@ -164,7 +164,7 @@ \li Select the \inlineimage qtcreator-debug-button-stop.png "Stop button" - button to view the results of the analysis in the \gui Profile + button to view the results of the analysis in the \uicontrol Profile view. \endlist @@ -177,7 +177,7 @@ the runtime behavior of an application. Double-click a function to view information about the calling functions in - the \gui Callers view and about the called functions in the \gui Callees + the \uicontrol Callers view and about the called functions in the \uicontrol Callees view. Since the run-time characteristics of debug and release @@ -204,12 +204,12 @@ separately for each project in the \l{Specifying Run Settings}{run settings} of the project. - To specify settings for Valgrind, select \gui {Tools > Options > - Analyzer}. The \gui {Profiling Options} group contains Callgrind options. + To specify settings for Valgrind, select \uicontrol {Tools > Options > + Analyzer}. The \uicontrol {Profiling Options} group contains Callgrind options. \image qtcreator-valgrind-callgrind-options.png "Valgrind options" - In the \gui {Result view: Minimum event cost} + In the \uicontrol {Result view: Minimum event cost} field, limit the amount of results the profiler gives you to increase profiler performance. @@ -219,7 +219,7 @@ \section2 Enabling Full Cache Simulation By default, only instruction read accesses (Ir) are counted. To fully - simulate the cache, select the \gui {Enable cache simulation} check box. + simulate the cache, select the \uicontrol {Enable cache simulation} check box. This enables the following additional event counters: \list @@ -235,7 +235,7 @@ \section2 Enabling Branch Prediction Simulation To enable the following additional event counters, select the - \gui {Enable branch prediction simulation} check box: + \uicontrol {Enable branch prediction simulation} check box: \list @@ -266,9 +266,9 @@ \list 1 - \li Select \gui Analyze > \gui {Valgrind Memory Analyzer (External + \li Select \uicontrol Analyze > \uicontrol {Valgrind Memory Analyzer (External Remote Application)} or - \gui {Valgrind Function Profiler (External Remote Application)}. + \uicontrol {Valgrind Function Profiler (External Remote Application)}. \image qtcreator-valgrind-remote-settings.png "Start Analyzer dialog" diff --git a/doc/src/analyze/qtquick-profiler.qdoc b/doc/src/analyze/qtquick-profiler.qdoc index ff36db792c..fd89323462 100644 --- a/doc/src/analyze/qtquick-profiler.qdoc +++ b/doc/src/analyze/qtquick-profiler.qdoc @@ -38,63 +38,63 @@ for the project. For more information, see \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. \note To profile applications on devices, you must install Qt 4.7.4 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. \li Select the \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. \note If data collection does not start automatically, select the \inlineimage qtcreator-analyzer-button.png - (\gui {Enable Profiling}) button. + (\uicontrol {Enable Profiling}) button. \endlist When you start analyzing an application, the application is launched, and 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 takes time, and therefore, there might be a delay before the data is displayed. 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 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 application is launched. Data collection starts when you select the button again. 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 - data, select \gui {Load QML Trace}. You can also deliver the saved data to + the context menu, and then select \uicontrol {Save QML Trace}. To view the saved + data, select \uicontrol {Load QML Trace}. You can also deliver the saved data to other developers for examination or load data saved by them. \section1 Attaching to Running Qt Quick Applications 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 \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. \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. \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 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 - 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). 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 - also move between events by selecting the \gui {Jump to Previous Event} (1) - and \gui {Jump to Next Event} (2) buttons. + also move between events by selecting the \uicontrol {Jump to Previous Event} (1) + 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 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 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 - \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 handle to define the end of the range. The length of the range indicates the frame rate of the event. 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 - 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. 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 @@ -158,7 +158,7 @@ \li Commercial Only \row - \li \gui {Pixmap Cache} + \li \uicontrol {Pixmap Cache} \li Displays the general amount of pixmap data cached, in pixels. In addition, displays a separate event for each picture being loaded, with specifics about its file name and size. @@ -167,7 +167,7 @@ \li \image ok \row - \li \gui {Scene Graph} + \li \uicontrol {Scene Graph} \li Displays the time when scene graph frames are rendered and some additional timing information for the various stages executed to do so. @@ -175,7 +175,7 @@ \li Qt Quick 2 \li \image ok \row - \li \gui {Memory Usage} + \li \uicontrol {Memory Usage} \li Displays block allocations of the JavaScript memory manager. Generally, the memory manager will reserve larger blocks of memory in one piece and later hand them out to the application in smaller @@ -191,21 +191,21 @@ \li \image ok \row - \li \gui {Input Events} + \li \uicontrol {Input Events} \li Displays mouse and keyboard events. \li Qt 4.7.4 \li Qt Quick 1 or Qt Quick 2 \li \image ok \row - \li \gui Painting + \li \uicontrol Painting \li Displays the time spent painting the scene for each frame. \li Qt 4.7.4 \li Qt Quick 1 \li \row - \li \gui Animations + \li \uicontrol Animations \li Displays the amount of animations that are active and the frame rate that they are running at. Information about render thread animations is displayed for @@ -216,14 +216,14 @@ \li \row - \li \gui Compiling + \li \uicontrol Compiling \li Displays the time spent compiling the QML files. \li Qt 4.7.4 \li Qt Quick 1 or Qt Quick 2 \li \row - \li \gui Creating + \li \uicontrol Creating \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 stage is for the creation of the data structures, including child @@ -238,7 +238,7 @@ \li \row - \li \gui Binding + \li \uicontrol Binding \li Displays the time when a binding is evaluated and how long the evaluation takes. \li Qt 4.7.4 @@ -246,7 +246,7 @@ \li \row - \li \gui {Handling Signal} + \li \uicontrol {Handling Signal} \li Displays the time when a signal is handled and how long the handling takes. \li Qt 4.7.4 @@ -254,7 +254,7 @@ \li \row - \li \gui JavaScript + \li \uicontrol JavaScript \li Displays the time spent executing the actual JavaScript behind bindings and signal handlers. It lists all the JavaScript functions you may be using to evaluate bindings or handle signals. @@ -270,7 +270,7 @@ understand how the Qt Quick scene graph works. See \l {Qt Quick Scene Graph} and \l {Qt Quick Scene Graph Renderer} for a 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 thread and the distinction between GUI thread and render thread is meaningless. @@ -288,7 +288,7 @@ \li Description \li Caveats \row - \li \gui {Polish} + \li \uicontrol {Polish} \li GUI \li Threaded, Basic, Windows \li polish @@ -297,18 +297,18 @@ \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. \row - \li \gui {GUI Thread Wait} + \li \uicontrol {GUI Thread Wait} \li GUI \li Threaded \li lock \li Executing slots connected to the QQuickWindow::afterAnimating() signal and then locking the render thread's mutex before waiting on - the same mutex at \gui {GUI Thread Sync}. If this starts long - before \gui {Render Thread Sync}, there is \e free time in the GUI + the same mutex at \uicontrol {GUI Thread Sync}. If this starts long + before \uicontrol {Render Thread Sync}, there is \e free time in the GUI thread you could be using for running additional QML or JavaScript. \li None \row - \li \gui {GUI Thread Sync} + \li \uicontrol {GUI Thread Sync} \li GUI \li Threaded \li blockedForSync @@ -316,18 +316,18 @@ to synchronize the QML state into the scene graph. \li None \row - \li \gui {Animations} + \li \uicontrol {Animations} \li GUI \li Threaded, Windows \li animations \li Advancing animations in the GUI thread. The basic render loop does not drive animations in sync with the rendering. This is why no 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. \li None \row - \li \gui {Render Thread Sync} + \li \uicontrol {Render Thread Sync} \li Render \li Threaded, Basic, Windows \li Frame rendered ... sync @@ -335,21 +335,21 @@ QQuickItem::updatePaintNode(). \li None \row - \li \gui {Render} + \li \uicontrol {Render} \li Render \li Threaded, Basic, Windows \li Frame rendered ... render \li Total time spent rendering the frame, including preparing and 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. \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 microseconds due to different, unsynchronized timers being used to - measure them. For example \gui {Render Preprocess} might seem to - start before \gui {Render Thread Sync} is finished. + measure them. For example \uicontrol {Render Preprocess} might seem to + start before \uicontrol {Render Thread Sync} is finished. \row - \li \gui {Swap} + \li \uicontrol {Swap} \li Render \li Threaded, Basic, Windows \li Frame rendered ... swap @@ -358,54 +358,54 @@ incorrect for the basic render loop and versions of Qt prior to Qt 5.4. The QML profiler shows the correct swap times. \row - \li \gui {Render Preprocess} + \li \uicontrol {Render Preprocess} \li Render \li Threaded, Basic, Windows \li time in renderer ... preprocess \li Calling QSGNode::preprocess() on all nodes that need to be - preprocessed. This is part of the gross \gui {Render} step. - \li May not be properly aligned with \gui {Render} with versions of Qt + preprocessed. This is part of the gross \uicontrol {Render} step. + \li May not be properly aligned with \uicontrol {Render} with versions of Qt prior to Qt 5.5. \row - \li \gui {Render Update} + \li \uicontrol {Render Update} \li Render \li Threaded, Basic, Windows \li time in renderer ... updates \li Iterating and processing all the nodes in the scene graph to update their geometry, transformations, opacity, and other state. In the - \gui {Render Thread Sync} stage, each node is updated separately - with state from the GUI thread. In \gui {Render Update}, all the + \uicontrol {Render Thread Sync} stage, each node is updated separately + 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 - gross \gui {Render} step. - \li May not be properly aligned with \gui {Render} with versions of Qt + gross \uicontrol {Render} step. + \li May not be properly aligned with \uicontrol {Render} with versions of Qt prior to Qt 5.5. \row - \li \gui {Render Bind} + \li \uicontrol {Render Bind} \li Render \li Threaded, Basic, Windows \li time in renderer ... binding \li Binding the correct framebuffer for OpenGL rendering. This is part - of the gross \gui {Render} step. - \li May not be properly aligned with \gui {Render} with versions of Qt + of the gross \uicontrol {Render} step. + \li May not be properly aligned with \uicontrol {Render} with versions of Qt prior to Qt 5.5. \row - \li \gui {Render Render} + \li \uicontrol {Render Render} \li Render \li Threaded, Basic, Windows \li time in renderer ... rendering \li The actual process of sending all the data to the GPU via OpenGL. - This is part of the gross \gui {Render} step. - \li May not be properly aligned with \gui {Render} with versions of Qt + This is part of the gross \uicontrol {Render} step. + \li May not be properly aligned with \uicontrol {Render} with versions of Qt prior to Qt 5.5. \row - \li \gui {Material Compile} + \li \uicontrol {Material Compile} \li Render \li Threaded, Basic, Windows \li shader compiled \li Compiling GLSL shader programs. \li None \row - \li \gui {Glyph Render} + \li \uicontrol {Glyph Render} \li Render \li Threaded, Basic, Windows \li glyphs ... rendering @@ -413,7 +413,7 @@ \li Versions of Qt prior to Qt 5.4 report incorrect times for these events. \row - \li \gui {Glyph Upload} + \li \uicontrol {Glyph Upload} \li Render \li Threaded, Basic, Windows \li glyphs ... upload @@ -421,14 +421,14 @@ \li Versions of Qt prior to Qt 5.4 report incorrect times for these events. \row - \li \gui {Texture Bind} + \li \uicontrol {Texture Bind} \li Render \li Threaded, Basic, Windows \li plain texture ... bind \li Binding a texture in the OpenGL context using glBindTextures. \li None \row - \li \gui {Texture Convert} + \li \uicontrol {Texture Convert} \li Render \li Threaded, Basic, Windows \li plain texture ... convert @@ -436,28 +436,28 @@ for usage as a texture. \li None \row - \li \gui {Texture Swizzle} + \li \uicontrol {Texture Swizzle} \li Render \li Threaded, Basic, Windows \li plain texture ... swizzle \li Swizzling the texture data on the CPU if necessary. \li None \row - \li \gui {Texture Upload} + \li \uicontrol {Texture Upload} \li Render \li Threaded, Basic, Windows \li plain texture ... upload / atlastexture uploaded \li Uploading the texture data to the GPU. \li None \row - \li \gui {Texture Mipmap} + \li \uicontrol {Texture Mipmap} \li Render \li Threaded, Basic, Windows \li plain texture ... mipmap \li Mipmapping a texture on the GPU. \li None \row - \li \gui {Texture Delete} + \li \uicontrol {Texture Delete} \li Render \li Threaded, Basic, Windows \li plain texture deleted @@ -467,51 +467,51 @@ \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 takes. This allows you to examine which events you need to optimize. A high number of occurrences might indicate that an event is triggered 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 in the code editor. JavaScript events often duplicate bindings or signals, so you can show and - hide them by selecting \gui {Show JavaScript Events} in the context menu. - To show and hide QML events (\gui Create, \gui Compile, and \gui Signal), - select \gui {Show QML Events}. + hide them by selecting \uicontrol {Show JavaScript Events} in the context + menu. To show and hide QML events (\uicontrol Create, \uicontrol Compile, + and \uicontrol Signal), select \uicontrol {Show QML Events}. \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. - 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. - 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. 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 - displayed in the \gui Events view. To view an event range in the \gui Events - view, select \gui {Limit Events Pane to Current Range} in the context menu - in the \gui Timeline view. + When you select an event in the \uicontrol Timeline view, information about it is + displayed in the \uicontrol Events view. To view an event range in the \uicontrol Events + view, select \uicontrol {Limit Events Pane to Current Range} in the context menu + in the \uicontrol Timeline view. 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 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 The QML JavaScript engine optimizes trivial bindings. The QML Profiler may not receive all information about optimized bindings, and therefore, - it may display the text \gui {<bytecode>} and the message - \gui {Source code not available} in the \gui Callers and \gui {Callees} + it may display the text \uicontrol {<bytecode>} and the message + \uicontrol {Source code not available} in the \uicontrol Callers and \uicontrol {Callees} panes. To inspect the optimized bindings, turn off the QML optimizer by setting @@ -520,9 +520,9 @@ \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. diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc index 0dfacb9b59..622ad489e6 100644 --- a/doc/src/android/androiddev.qdoc +++ b/doc/src/android/androiddev.qdoc @@ -128,17 +128,17 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui Android to add paths to the + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Android to add paths to the Android NDK and SDK. You can use the \inlineimage qtcreator-options-android-download-button.png - (\gui Download) buttons to go to the sites where you can download + (\uicontrol Download) buttons to go to the sites where you can download the Android NDK and SDK. \image qtcreator-options-android1.png "Android options" - \li Select the \gui {Automatically create kits for Android tool chains} + \li Select the \uicontrol {Automatically create kits for Android tool chains} check box to allow \QC to create the kits for you. \QC displays a warning if it cannot find a suitable Qt version. @@ -146,54 +146,54 @@ \list - \li To use Gradle, select the \gui {Use Gradle instead of Ant} + \li To use Gradle, select the \uicontrol {Use Gradle instead of Ant} check box. \li To use Ant, add the path to the Ant executable in the - \gui {Ant executable} field. + \uicontrol {Ant executable} field. \endlist - \li Select \gui File > \gui {New File or Project} > \gui Application > - \gui {Qt Quick Application} > \gui Choose, and + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > + \uicontrol {Qt Quick Application} > \uicontrol Choose, and follow the instructions of the wizard. For more information, see \l{Creating Qt Quick Projects}. \li To specify settings for deploying applications to Android, select - \gui Projects > \gui Run for the \gui Android kit, and then select - \gui Details to view the \gui {Deploy configurations}. For more + \uicontrol Projects > \uicontrol Run for the \uicontrol Android kit, and then select + \uicontrol Details to view the \uicontrol {Deploy configurations}. For more information about the options you have, see \l{Deploying Applications to Android Devices}. \li Enable debugging on your Android device. Debugging is enabled in different ways on different Android devices. - Look for \gui {USB Debugging} under \gui {Developer Options}. On - some devices \gui {Developer Options} is hidden and becomes visible - when you tap the \gui {Build number} field in \gui Settings > - \gui About several times. + Look for \uicontrol {USB Debugging} under \uicontrol {Developer Options}. On + some devices \uicontrol {Developer Options} is hidden and becomes visible + when you tap the \uicontrol {Build number} field in \uicontrol Settings > + \uicontrol About several times. \li Connect the Android device to the development PC with a USB cable. You might be asked to select a device in the - \gui {Select Android Devices} dialog. + \uicontrol {Select Android Devices} dialog. \endlist \section1 Selecting Android Devices When you deploy an application to an Android device with Android - version 4.2 or later, the \gui {Select Android Devices} dialog opens. It + version 4.2 or later, the \uicontrol {Select Android Devices} dialog opens. It lists the devices that are connected to the development PC. and their - status. You can select devices from the \gui {Compatible Devices} list for + status. You can select devices from the \uicontrol {Compatible Devices} list for deployment. If \QC determines that a device is not ready for deployment, it places the - device in the \gui {Incompatible Devices} list, with information about the + device in the \uicontrol {Incompatible Devices} list, with information about the issue. For example, you might need to authorize the connection on the device. After you authorize the connection on the device, select - \gui {Refresh Device List}. The device is moved to the - \gui {Compatible Devices} list and you can select it for deployment. + \uicontrol {Refresh Device List}. The device is moved to the + \uicontrol {Compatible Devices} list and you can select it for deployment. - Other reasons for placing a device on the \gui {Incompatible Devices} are + Other reasons for placing a device on the \uicontrol {Incompatible Devices} are that the Android version on the device is too old or that the tool chain used for building does not match the Android architecture on the device (for example, you cannot deploy an ARM build on an x86 device). @@ -201,21 +201,21 @@ \image qtcreator-android-select-devices.png "Select Android Devices dialog" Android Virtual Devices (AVD) are also listed. To create new AVDs, select - \gui {Create Android Virtual Device}. + \uicontrol {Create Android Virtual Device}. To set a device as the default device for a particular Android architecture, - select the \gui {Always use this device for architecture} check box. The - \gui {Select Android Devices} dialog will not appear until you switch to + select the \uicontrol {Always use this device for architecture} check box. The + \uicontrol {Select Android Devices} dialog will not appear until you switch to another project or restart \QC. \section1 Using the Android Emulator To run your application on the Android Emulator, you must create Android - virtual devices (AVD). Select \gui Tools > \gui Options > \gui Android > - \gui Add. If you run an application without a device connected to the + virtual devices (AVD). Select \uicontrol Tools > \uicontrol Options > \uicontrol Android > + \uicontrol Add. If you run an application without a device connected to the development PC and without an AVD specified, \QC asks you to add an AVD. - To manage AVDs, select \gui {Start AVD Manager}. + To manage AVDs, select \uicontrol {Start AVD Manager}. \note The Android Emulator has a bug that prevents it from starting on some systems. If the Android Emulator does not start, you can try starting it @@ -228,7 +228,7 @@ information, see the Android documentation. In addition, debugging is supported at android-10 API level, or higher. In - the run settings for the project, in the \gui {Android build SDK} field, + the run settings for the project, in the \uicontrol {Android build SDK} field, select android-10, or higher. For more information about Android API levels, see \l{http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels} {What is API Level?}. diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc index 6024ec0ba6..c23e6ecf28 100644 --- a/doc/src/android/deploying-android.qdoc +++ b/doc/src/android/deploying-android.qdoc @@ -45,13 +45,13 @@ \endlist - To specify settings for application packages, select \gui Projects > - \gui {Build Android APK} > \gui Details. + To specify settings for application packages, select \uicontrol Projects > + \uicontrol {Build Android APK} > \uicontrol Details. \section1 Creating Distributable APK Packages To copy Qt libraries and files to the project directory and to bundle them - as part of the APK, select the \gui {Bundle Qt libraries in APK} option. + as part of the APK, select the \uicontrol {Bundle Qt libraries in APK} option. \note Android 5 devices support only this option. @@ -70,7 +70,7 @@ created by \QC. To use Ministro to install the Qt libraries, select the - \gui {Use Ministro service to install Qt} option. + \uicontrol {Use Ministro service to install Qt} option. \section1 Deploying Qt Libraries for Debugging @@ -84,7 +84,7 @@ turn-around time, and is therefore convenient for testing the application during development. - Select the \gui {Deploy local Qt libraries to temporary directory} option to + Select the \uicontrol {Deploy local Qt libraries to temporary directory} option to deploy Qt libraries to the \c{/data/local/tmp/qt} folder on the device and to run the application against them. @@ -92,7 +92,7 @@ Because bundling applications as APK packages is not trivial, Qt 5 provides a deployment tool called \c androiddeployqt. - When you deploy an application using a \gui {Qt for Android Kit}, \QC uses + When you deploy an application using a \uicontrol {Qt for Android Kit}, \QC uses the \c androiddeployqt tool to create the necessary files and to bundle them into an APK: @@ -122,15 +122,15 @@ \endlist The Gradle wrappers and scripts are bundled only if you use Gradle, which is - the default. To use Ant instead, deselect the \gui {Use Gradle} check box. + the default. To use Ant instead, deselect the \uicontrol {Use Gradle} check box. To view the packages that the \c androiddeployqt tool created, select the - \gui {Open package location after build} check box. + \uicontrol {Open package location after build} check box. The packages are deployed on the connected Android devices. To switch the device used as a default device for the selected kit, select - \gui Projects > \gui Run > - \gui {Reset Default Devices}. The setting applies until you restart \QC. + \uicontrol Projects > \uicontrol Run > + \uicontrol {Reset Default Devices}. The setting applies until you restart \QC. For more information, see \l{Selecting Android Devices}. For more information about the \c androiddeployqt tool, see @@ -139,8 +139,8 @@ \section2 Specifying Settings for Packages You can specify settings for the \c androiddeployqt tool in \QC and in the - project .pro file. To specify settings in \QC, select \gui Projects > - \gui {Build Android APK} > \gui Details. + project .pro file. To specify settings in \QC, select \uicontrol Projects > + \uicontrol {Build Android APK} > \uicontrol Details. \image qtcreator-android-deploy-configurations.png "Deploy configurations" @@ -150,12 +150,12 @@ \l{Deploying an Application on Android#qmake-variables}{qmake Variables}. You can view information about what the anddroiddeployqt tool is doing in - the \gui {Compile Output} pane. To view additional information, select the - \gui {Verbose output} check box. + the \uicontrol {Compile Output} pane. To view additional information, select the + \uicontrol {Verbose output} check box. \section3 Selecting API Level - In the \gui {Android build SDK} field, you can select the API level to use + In the \uicontrol {Android build SDK} field, you can select the API level to use for building the application. Usually, you should select the newest API level available. @@ -197,45 +197,45 @@ \list 1 - \li In the \gui Keystore field, select \gui Create to create a new - keystore that contains one key pair in the \gui {Create Keystore and + \li In the \uicontrol Keystore field, select \uicontrol Create to create a new + keystore that contains one key pair in the \uicontrol {Create Keystore and a Certificate} dialog: \image qtcreator-android-certificate.png - \li In the \gui Keystore group, enter a password to protect the + \li In the \uicontrol Keystore group, enter a password to protect the keystore. - \li In the \gui Certificate group, specify the key size and validity + \li In the \uicontrol Certificate group, specify the key size and validity period of the certificate. You can specify a separate password to protect the key pair or use the keystore password. - \li In the \gui {Certificate Distinguished Names} group, enter + \li In the \uicontrol {Certificate Distinguished Names} group, enter information about yourself and your company or organization that identifies the issuer and the owner of the key pair. - \li Select \gui Save. + \li Select \uicontrol Save. - \li In the \gui {Keystore File Name} dialog, enter a name for the + \li In the \uicontrol {Keystore File Name} dialog, enter a name for the keystore and select a location for it. - \li In the \gui Keystore dialog, enter the keystore password to create + \li In the \uicontrol Keystore dialog, enter the keystore password to create the key pair in the keystore. \endlist To sign an Android package by using a key pair, specify settings in the - \gui {Sign package} group: + \uicontrol {Sign package} group: \list 1 - \li In the \gui Keystore field, select \gui Choose to select an existing + \li In the \uicontrol Keystore field, select \uicontrol Choose to select an existing keystore. - \li In the \gui {Certificate alias} field, select an alias from the list + \li In the \uicontrol {Certificate alias} field, select an alias from the list of key pairs that the keystore contains. - \li Select the \gui {Sign package} check box to use the alias to + \li Select the \uicontrol {Sign package} check box to use the alias to sign the Android package. \endlist @@ -244,12 +244,12 @@ \QC automatically detects which Qt libraries the application uses and adds them as dependencies. If the application needs external libraries, specify - them in the \gui {Additional Libraries} field. The libraries are copied into + them in the \uicontrol {Additional Libraries} field. The libraries are copied into your application's library folder and loaded on startup. For example, to enable OpenSSL in your application, add the paths to the required \c libssl.so and \c libcrypto.so libraries to the - \gui {Additional Libraries} field. + \uicontrol {Additional Libraries} field. \section3 Editing Manifest Files @@ -258,14 +258,14 @@ Android manifest file until you want to publish the package in an application store. To specify additional settings for APK packages, you can create an Android manifest file and edit it in \QC. Select - \gui {Create Templates} to create the file and to open it in the + \uicontrol {Create Templates} to create the file and to open it in the Android Manifest Editor. \image qtcreator-android-manifest-editor.png "Android Manifest Editor" \list 1 - \li In the \gui {Package name} field, enter a package name for the application. + \li In the \uicontrol {Package name} field, enter a package name for the application. The application is launched by an automatically generated Java launcher that is packaged with the application into an Android package (.apk). For more information, see @@ -273,39 +273,39 @@ {Android Application Fundamentals}. \li You can specify an internal version number for the package in the - \gui {Version code} field. It is used to determine whether one version of - the application is more recent than another. In the \gui {Version name} + \uicontrol {Version code} field. It is used to determine whether one version of + the application is more recent than another. In the \uicontrol {Version name} field, specify the version number that is shown to users. - \li In the \gui {Minimum required SDK} field, select the minimum API level + \li In the \uicontrol {Minimum required SDK} field, select the minimum API level required to run the application. The minimum supported API level is android-9. \QC does not allow you to select an API level that the Qt version specified for the kit does not support. - \li In the \gui {Target SDK} field, select the targeted API level of the + \li In the \uicontrol {Target SDK} field, select the targeted API level of the application. This affects the activation of some compatibility features in the OS. The value used by the \c androiddeployqt tool by default is 14, which means that the overflow button in the system navigation bar will not be enabled by default. - \li In the \gui Application group, you can give the application a name and + \li In the \uicontrol Application group, you can give the application a name and select an icon for it. The three icon fields can contain different versions of the icon with low, medium, and high DPI values, from left to right. - \li In the \gui Permissions field, you can specify the permissions that your + \li In the \uicontrol Permissions field, you can specify the permissions that your application needs. Users are asked to grant the permissions when they install the application. Android OS then grants the application access to the appropriate data and features. - \li Select the \gui {Include default permissions for Qt modules} and - \gui {Include default features for Qt modules} check boxes to add the + \li Select the \uicontrol {Include default permissions for Qt modules} and + \uicontrol {Include default features for Qt modules} check boxes to add the permissions needed by Qt libraries. - \li To add permissions, select them in the list, and then select \gui Add. + \li To add permissions, select them in the list, and then select \uicontrol Add. \endlist - Select the \gui {XML Source} tab to edit the file in XML format. + Select the \uicontrol {XML Source} tab to edit the file in XML format. \section1 Installing Ministro @@ -317,7 +317,7 @@ from the Google Market or from the \l{http://necessitas.kde.org/necessitas/ministro.php}{Ministro} home page. - Then select \gui Projects > \gui Run > \gui {Install Ministro from APK}. + Then select \uicontrol Projects > \uicontrol Run > \uicontrol {Install Ministro from APK}. You can use this option also to install any Android package (.apk). diff --git a/doc/src/baremetal/creator-baremetal-dev.qdoc b/doc/src/baremetal/creator-baremetal-dev.qdoc index 5d9df8b32c..d1d3a2d509 100644 --- a/doc/src/baremetal/creator-baremetal-dev.qdoc +++ b/doc/src/baremetal/creator-baremetal-dev.qdoc @@ -40,18 +40,18 @@ \list 1 - \li Select \gui Help > \gui {About Plugins} > \gui {Device Support} > - \gui {Bare Metal} to enable the Bare Metal Device plugin. + \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {Device Support} > + \uicontrol {Bare Metal} to enable the Bare Metal Device plugin. \li Restart \QC to be able to use the plugin. - \li Select \gui Tools > \gui Options > \gui Devices > \gui Add > - \gui {Bare Metal Device} > \gui {Start Wizard}. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices > \uicontrol Add > + \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. - \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. \li To specify build settings: @@ -61,7 +61,7 @@ \li Open a project for an application you want to develop for the 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 devices. @@ -69,7 +69,7 @@ \endlist - \li Select \gui Run to specify run settings. + \li Select \uicontrol Run to specify run settings. Usually, you can use the default settings. diff --git a/doc/src/debugger/creator-debugger-example.qdoc b/doc/src/debugger/creator-debugger-example.qdoc index d944057824..87ab867bf8 100644 --- a/doc/src/debugger/creator-debugger-example.qdoc +++ b/doc/src/debugger/creator-debugger-example.qdoc @@ -31,7 +31,7 @@ \title Debugging a C++ Example Application 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. TextFinder reads a text file into QString and then displays it with @@ -45,19 +45,19 @@ \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}. - \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 \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, - go to the \gui{Locals and Expressions} view. + go to the \uicontrol{Locals and Expressions} view. \image qtcreator-watcher.png @@ -101,12 +101,12 @@ work correctly due to a logic error. To locate this logic error, step through the code using the following buttons: \inlineimage qtcreator-debug-button-stop.png - (\gui Stop), + (\uicontrol Stop), \inlineimage qtcreator-debug-button-step-over.png - (\gui {Step Over}), + (\uicontrol {Step Over}), \inlineimage qtcreator-debug-button-step-into.png - (\gui {Step Into}), and + (\uicontrol {Step Into}), and \inlineimage qtcreator-debug-button-step-out.png - (\gui {Step Out}). + (\uicontrol {Step Out}). */ diff --git a/doc/src/debugger/creator-debugger-setup.qdoc b/doc/src/debugger/creator-debugger-setup.qdoc index 0325a210d0..a2c5b2102b 100644 --- a/doc/src/debugger/creator-debugger-setup.qdoc +++ b/doc/src/debugger/creator-debugger-setup.qdoc @@ -33,8 +33,8 @@ The main debugger settings are associated with 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 > - \gui Options > \gui {Build and Run} > \gui Kits. + debugger and compiler to use for each kit, select \uicontrol Tools > + \uicontrol Options > \uicontrol {Build and Run} > \uicontrol Kits. You need to set up the debugger only if the automatic setup 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 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. 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. \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 flag in your \l{glossary-run-config}{run configuration}, in - \gui Projects mode. In the run configuration, select - \gui{Use debug version of frameworks}. + \uicontrol Projects mode. In the run configuration, select + \uicontrol{Use debug version of frameworks}. 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} @@ -238,13 +239,13 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui Debugger > \gui General > - \gui Add. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger + > \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. - \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. \endlist @@ -257,13 +258,14 @@ \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 - and select \gui{Symbol Server}. + \li In the \uicontrol {Symbol paths} field, open the \uicontrol Insert + menu and select \uicontrol{Symbol Server}. \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 \c {C:\temp\symbolcache}. @@ -283,32 +285,32 @@ \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}: \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. - \li In the \gui {Certificate Type} field, select - \gui {Code Signing}. + \li In the \uicontrol {Certificate Type} field, select + \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 - wizard (use the default settings), until the \gui {Specify a + \li Select \uicontrol Continue, and follow the instructions of the + wizard (use the default settings), until the \uicontrol {Specify a 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. \li Double click the certificate to view certificate information. - \li In the \gui Trust section, select \gui {Always Trust} in the - \gui {When using this certificate} field, and then close + \li In the \uicontrol Trust section, select \uicontrol {Always Trust} in the + \uicontrol {When using this certificate} field, and then close the dialog. \endlist @@ -319,14 +321,14 @@ codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb \endcode - \li In \QC, select \gui {Qt Creator > Preferences > Build & Run > - Kits} > \gui Add to create a kit that uses FSF GDB. + \li In \QC, select \uicontrol {Qt Creator > Preferences > Build & Run > + 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). - \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. \endlist @@ -338,17 +340,18 @@ \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 - \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 - is not listed, select \gui Manage to add it in \gui Tools > - \gui Options > \gui {Build & Run} > \gui Debuggers. For more + \li In the \uicontrol Debugger field, select an LLDB Engine. If an LLDB Engine + is not listed, select \uicontrol Manage to add it in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Debuggers. For more 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. \endlist diff --git a/doc/src/debugger/creator-debugger.qdoc b/doc/src/debugger/creator-debugger.qdoc index 7dc78d23c0..9143c15eb1 100644 --- a/doc/src/debugger/creator-debugger.qdoc +++ b/doc/src/debugger/creator-debugger.qdoc @@ -49,12 +49,12 @@ To start an application from an open project under the control of a debugger, press the Debug button in the lower left corner 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. \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. \li \l{Using Debugging Helpers} @@ -99,13 +99,13 @@ \title Launching the Debugger 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}. \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 - \gui{Always deploy before running} options are selected in the - \gui{Build and Run} options. + and deploys it if the \uicontrol{Always build project before deploying it} and + \uicontrol{Always deploy before running} options are selected in the + \uicontrol{Build and Run} options. The debugger then takes over and starts the program with suitable parameters. @@ -122,7 +122,7 @@ Some of the modes are only available for a particular operating system or 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. So if the current project is set up as a C++ application using the MinGW toolchain targeting desktop Windows, the GDB engine will @@ -132,8 +132,8 @@ being handled by GDB and GDB server remote debugging. Change the run configuration - parameters (such as \gui{Run in Terminal}) in the run settings of the - project, or select options from the \gui{Debug} > \gui{Start Debugging} + parameters (such as \uicontrol{Run in Terminal}) in the run settings of the + project, or select options from the \uicontrol{Debug} > \uicontrol{Start Debugging} menu to select other modes of operation. The debugger can run in the following modes: @@ -163,11 +163,11 @@ all projects using a desktop Qt version and plain C++ projects. 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 - Settings} and select the \gui {Run in terminal} check box. + it accepts console input from the user, go to \uicontrol {Projects > Run + Settings} and select the \uicontrol {Run in terminal} check box. 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. For more information, see \l{Setting Breakpoints}. @@ -175,14 +175,14 @@ \section2 Launching in Start External Mode 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}. \section2 Launching in Attach Mode To attach the debugger to an application already running on your 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. While this mode does not strictly require a project to be opened in \QC, @@ -206,7 +206,7 @@ ulimit -c unlimited \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}. Also in this mode, using a properly configured project containing @@ -220,11 +220,11 @@ The \QC installation program asks you whether you want to register \QC as a post-mortem debugger. To change the setting, select - \gui Tools > \gui Options > \gui Debugger > \gui General > \gui {Use Qt - Creator for post-mortem debugging}. + \uicontrol Tools > \uicontrol Options > \uicontrol Debugger > + \uicontrol General > \uicontrol {Use QtCreator for post-mortem debugging}. 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. @@ -244,8 +244,8 @@ the user of \QC. To start debugging on a remote target with the necessary helper processes running, select the corresponding \l{glossary-buildandrun-kit}{kit} in - \gui{Projects > Build & Run}, and then select a function to start remote - debugging in the \gui{Debug > Start Debugging} menu. + \uicontrol{Projects > Build & Run}, and then select a function to start remote + debugging in the \uicontrol{Debug > Start Debugging} menu. Special use cases, such as attaching to a running process on the target, might still require manual setup. @@ -273,13 +273,13 @@ \list 1 - \li Select \gui {Debug > Start Debugging > Attach to Remote + \li Select \uicontrol {Debug > Start Debugging > Attach to Remote 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. - \li Select \gui{OK} to start debugging. + \li Select \uicontrol{OK} to start debugging. \endlist @@ -322,10 +322,10 @@ \endcode \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: \code @@ -345,7 +345,7 @@ ssl:proto=Protocol,{certuser=Cert|machuser=Cert},clicon=Server,port=Socket[,password=Password] \endcode - \li Click \gui{OK} to start debugging. + \li Click \uicontrol{OK} to start debugging. \endlist */ @@ -359,7 +359,7 @@ \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, including the following: @@ -402,11 +402,11 @@ \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 you are debugging C++ or QML. Frequently used views are shown by 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 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. 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. 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 - selecting \gui{Debug} > \gui {Interrupt}. The program is automatically + selecting \uicontrol{Debug} > \uicontrol {Interrupt}. The program is automatically interrupted when a breakpoint is hit. Once the program stops, \QC: @@ -431,14 +431,14 @@ \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. \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: @@ -475,8 +475,8 @@ to you. You can then examine the state of the interrupted program, or continue execution either line-by-line or continuously. - \QC shows breakpoints in the \gui{Breakpoints} view which is enabled - by default. The \gui{Breakpoints} view is also accessible when the debugger + \QC shows breakpoints in the \uicontrol{Breakpoints} view which is enabled + by default. The \uicontrol{Breakpoints} view is also accessible when the debugger and the program being debugged is not running. \image qtcreator-debug-breakpoints.png "Breakpoints view" @@ -523,28 +523,28 @@ (\key F8 for OS X) at a particular line you want the 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. - \li In the \gui Breakpoints view, select \gui {Add Breakpoint} + \li In the \uicontrol Breakpoints view, select \uicontrol {Add Breakpoint} in the context menu. \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 to specify depend on the selected location. \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 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. - \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 in the order in which they are specified. @@ -566,11 +566,11 @@ \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}. - \li Select \gui{Delete Breakpoint} in the context menu in the - \gui Breakpoints view. + \li Select \uicontrol{Delete Breakpoint} in the context menu in the + \uicontrol Breakpoints view. \endlist @@ -583,20 +583,20 @@ \list 1 - \li Right-click in the \gui Breakpoints view to open the context menu, - and select \gui {Add Breakpoint}. + \li Right-click in the \uicontrol Breakpoints view to open the context menu, + 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}. - \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 - If the address is displayed in the \gui {Locals and Expressions} view, you - can select \gui {Add Data Breakpoint at Object's Address} in the context + If the address is displayed in the \uicontrol {Locals and Expressions} view, you + can select \uicontrol {Add Data Breakpoint at Object's Address} in the context menu to set the data breakpoint. \section1 Viewing Call Stack Trace @@ -606,22 +606,22 @@ trace. This stack trace is built up from call stack frames, each representing a particular function. For each function, \QC tries 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 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 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 - 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 function. 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 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. @@ -629,26 +629,26 @@ \section1 Locals and Expressions The Locals and Expressions view consists of three parts: the - \gui{Locals} pane at the top, the \gui{Return Value} pane in the middle, - and the \gui{Expressions} pane at the bottom. The \gui{Return Value} - and \gui{Expression} panes are only visible if they are not empty. + \uicontrol{Locals} pane at the top, the \uicontrol{Return Value} pane in the middle, + and the \uicontrol{Expressions} pane at the bottom. The \uicontrol{Return Value} + and \uicontrol{Expression} panes are only visible if they are not empty. \image qtcreator-locals-expressions.png "Locals and Expressions view" Whenever a program stops under the control of the debugger, it retrieves 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 frame as well as the local variables. If the last operation in 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. 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 - empty part of the \gui{Locals and Expressions} view, or select - \gui{Add New Expression Evaluator} from the context menu, or + empty part of the \uicontrol{Locals and Expressions} view, or select + \uicontrol{Add New Expression Evaluator} from the context menu, or drag and drop an expression from the code editor. \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 builds on Linux and OS X. Optimization can lead to 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. \row \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 local variable contains "real data", or "initial noise". If a 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. \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 to Qt's basic objects. 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 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 options depend on the type of the current items, and are provided by the \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 \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 - 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 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). 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. 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 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 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 - 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 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 - in the \gui{Locals and Expressions} view. + in the \uicontrol{Locals and Expressions} view. \section1 Debugging C++ Based Applications @@ -783,19 +783,19 @@ 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 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. \section2 Viewing Threads - If a multi-threaded program is interrupted, the \gui Threads view or the - combobox named \gui Threads in the debugger status bar can be used to - switch from one thread to another. The \gui Stack view adjusts itself + If a multi-threaded program is interrupted, the \uicontrol Threads view or the + combobox named \uicontrol Threads in the debugger status bar can be used to + switch from one thread to another. The \uicontrol Stack view adjusts itself accordingly. \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 is a dynamic link library (.dll) in Windows, a shared object (.so) in Linux, and a dynamic shared library (.dylib) in OS X. @@ -821,11 +821,11 @@ \endlist - By default, the \gui{Modules} view is hidden. + By default, the \uicontrol{Modules} view is hidden. \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 actually part of the project, or whether it was compiled 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 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 - The \gui{Disassembler} view displays disassembled code for the current - function. The \gui{Registers} view displays the current state of the CPU's + The \uicontrol{Disassembler} view displays disassembled code for the current + function. The \uicontrol{Registers} view displays the current state of the CPU's registers. - The \gui{Disassembler} view and the \gui{Registers} view are both useful - for low-level commands for checking single instructions, such as \gui{Step Into} - and \gui{Step Over}. By default, both \gui{Disassembler} and - \gui{Registers} view are hidden. + The \uicontrol{Disassembler} view and the \uicontrol{Registers} view are both useful + for low-level commands for checking single instructions, such as \uicontrol{Step Into} + and \uicontrol{Step Over}. By default, both \uicontrol{Disassembler} and + \uicontrol{Registers} view are hidden. \section2 Creating Snapshots A snapshot contains the complete state of the debugged program at a time, including the full memory contents. - To create snapshots of a debugged program, select \gui {Create Snapshot} in - the context menu in the \gui Snapshots view. + To create snapshots of a debugged program, select \uicontrol {Create Snapshot} in + 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 state of the program at time of taking the snapshot. @@ -870,17 +870,17 @@ \title Using Debugging Helpers 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. To access sub-structures of the objects, expand the tree nodes. 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. Similarly, pointers are displayed as a tree item with a single child item representing the target of the pointer. In case the 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 type of the pointer and the value of the target. @@ -897,9 +897,9 @@ scripts for use with the GDB and LLDB backends. Debugging helpers are always automatically used. To force a plain - C-like display of structures, select \gui Tools > \gui Options > - \gui Debugger > \gui {Locals & Expressions}, and then deselect the - \gui{Use Debugging Helper} check box. For GDB + C-like display of structures, select \uicontrol Tools > \uicontrol Options > + \uicontrol Debugger > \uicontrol {Locals & Expressions}, and then deselect the + \uicontrol{Use Debugging Helper} check box. For GDB and LLDB this will still use the Python scripts, but generate more basic output. To force plain display for a single object or for all objects of a given type, select the corresponding @@ -912,7 +912,7 @@ \section1 Extending GDB and LLDB Debugging Helpers 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, 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 types, add debugging helper implementations to the GDB startup file - \c{~/.gdbinit}, or specify them directly in the \gui{Additional - Startup Commands} in \gui {Tools > Options > Debugger > GDB}. + \c{~/.gdbinit}, or specify them directly in the \uicontrol{Additional + Startup Commands} in \uicontrol {Tools > Options > Debugger > GDB}. The implementation of a debugging helper typically 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 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: @@ -972,7 +972,7 @@ \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. \code {iname='some internal name', # optional @@ -998,7 +998,7 @@ present, is it generated by concatenating the parent object's iname, 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 is used instead. @@ -1208,8 +1208,8 @@ You might have created a release build that does not contain debug 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 - the \gui {Compile Output} pane. If it is not, adjust your build settings - in the \gui {Projects} mode. + the \uicontrol {Compile Output} pane. If it is not, adjust your build settings + in the \uicontrol {Projects} mode. \section1 Debugger Does Not Work @@ -1222,8 +1222,8 @@ \li Make sure the debugger is set up properly. For more information, see \l{Setting Up Debugger}. - \li In the \gui Debug mode, select \gui {Window > Views > Debugger - Log} to open the \gui {Debugger Log} view. Browse the contents of + \li In the \uicontrol Debug mode, select \uicontrol {Window > Views > Debugger + 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. Always attach the contents of the pane to debugger-related questions to the \QC mailing list (qt-creator@trolltech.com) @@ -1236,18 +1236,18 @@ \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 is displayed. To directly display the members of the pointer variable, - select \gui {Dereference Pointers Automatically} in the context menu in the - \gui {Locals and Expressions} view. + select \uicontrol {Dereference Pointers Automatically} in the context menu in the + \uicontrol {Locals and Expressions} view. \section1 Structure Members Are Not Sorted According to Structure Layout 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 - \gui {Locals and Expressions} view. + \uicontrol {Locals and Expressions} view. \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 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 \l{http://wiki.ubuntu.com/SecurityTeam/Roadmap/KernelHardening#ptrace%20Protection} diff --git a/doc/src/debugger/qtquick-debugger-example.qdoc b/doc/src/debugger/qtquick-debugger-example.qdoc index 8f30974234..e952214b74 100644 --- a/doc/src/debugger/qtquick-debugger-example.qdoc +++ b/doc/src/debugger/qtquick-debugger-example.qdoc @@ -33,7 +33,7 @@ This section uses the \l{QML Advanced Tutorial}{Same Game} 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 \l{Debugging Qt Quick Projects}. @@ -53,10 +53,10 @@ The red circle indicates that a breakpoint is now set on that line number. - \li Select \gui {Debug > Start Debugging > Start Debugging} or press + \li Select \uicontrol {Debug > Start Debugging > Start Debugging} or press \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. \li When the debugger hits the breakpoint, it interrupts the @@ -67,24 +67,24 @@ \li Click the \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 editor at the function that starts a new game. \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 the view. \li Add a breakpoint at the end of the \c {startNewGame()} function, and click \inlineimage qtcreator-debugging-continue.png - (\gui Continue) to hit the breakpoint. + (\uicontrol Continue) to hit the breakpoint. \image qtquick-example-setting-breakpoint3.png \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} in the console. @@ -92,27 +92,27 @@ \image qtquick-example-script-console.png \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: \image qtquick-example-qml-inspector.png \li Click \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. \li Click \inlineimage qml-inspector-select-button.png - (\gui Select) to activate selection mode and then click the - \gui {Quit} button to move into the \gui ButtonLabel component - in the \gui {QML/JS Console} and the code editor. + (\uicontrol Select) to activate selection mode and then click the + \uicontrol {Quit} button to move into the \uicontrol ButtonLabel component + in the \uicontrol {QML/JS Console} and the code editor. - \li In the \gui {Locals and Expressions} view, double-click the value of - the \c text property to change it temporarily from \gui {Quit} to - \gui {End Game}. + \li In the \uicontrol {Locals and Expressions} view, double-click the value of + the \c text property to change it temporarily from \uicontrol {Quit} to + \uicontrol {End Game}. \image qtquick-example-property-values.png diff --git a/doc/src/debugger/qtquick-debugging.qdoc b/doc/src/debugger/qtquick-debugging.qdoc index 18324af7d3..9b579ef75a 100644 --- a/doc/src/debugger/qtquick-debugging.qdoc +++ b/doc/src/debugger/qtquick-debugging.qdoc @@ -41,20 +41,20 @@ \l{Creating Qt Quick Projects}{type of the project}: Qt Quick UI or Qt Quick Application, and the Qt version used. - To debug Qt Quick UI projects, select the \gui {Enable QML} check box in the - \gui {Debugger Settings} in \gui Projects mode \gui {Run Settings}. + To debug Qt Quick UI projects, select the \uicontrol {Enable QML} check box in the + \uicontrol {Debugger Settings} in \uicontrol Projects mode \uicontrol {Run Settings}. To debug Qt Quick Applications: \list 1 \li Debugging is enabled by default for Qt 4.8, or later. For Qt 4.7, - select \gui Projects, and then select the - \gui {Enable QML debugging} check box in the \gui qmake section - in \gui {Build Steps}. + select \uicontrol Projects, and then select the + \uicontrol {Enable QML debugging} check box in the \uicontrol qmake section + in \uicontrol {Build Steps}. 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" @@ -64,11 +64,11 @@ functions. Therefore, you must make sure that the port is properly protected by a firewall. - \li In the \gui {Run Settings}, \gui {Debugger Settings} section, select - the \gui {Enable QML} check box to enable + \li In the \uicontrol {Run Settings}, \uicontrol {Debugger Settings} section, select + the \uicontrol {Enable QML} check box to enable 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. \li To debug applications on devices, check that Qt 4.7.4, or later, @@ -81,15 +81,15 @@ \section1 Mixed C++/QML Debugging 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 - languages in the \gui {Debugger Settings} section in the project - \gui{Run Settings}. + select the \uicontrol {Enable C++} and \uicontrol {Enable QML} checkboxes for both + languages in the \uicontrol {Debugger Settings} section in the project + \uicontrol{Run Settings}. \image qtquick-debugging-settings.png \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 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 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 be debugged is running. The port number to use is displayed in the @@ -142,7 +142,7 @@ \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: \list @@ -158,8 +158,9 @@ \section1 Executing JavaScript Expressions When the application is interrupted by a breakpoint, you can use the - \gui {QML/JS Console} to execute JavaScript expressions in the current - context. To open it, choose \gui Window > \gui {Output Panes} > \gui {QML/JS Console}. + \uicontrol {QML/JS Console} to execute JavaScript expressions in the current + context. To open it, choose \uicontrol Window > \uicontrol {Output Panes} + > \uicontrol {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 the file. This is enabled by default. To disable it, click the \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 - When you change property values in the \gui {QML/JS Console} or in the - \gui {Locals and Expressions} view, they are immediately updated in the running + When you change property values in the \uicontrol {QML/JS Console} or in the + \uicontrol {Locals and Expressions} view, they are immediately updated in the running application, but not in the source code. \section1 Inspecting Items 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" To keep the application visible while you interact with the debugger, click \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: \list @@ -204,7 +205,7 @@ \li Click \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. \endlist @@ -218,9 +219,9 @@ 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. - 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 - 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: @@ -237,14 +238,14 @@ \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 contains zoom controls. - To switch out of the selection or zoom mode, deselect the \gui Select or - \gui Zoom button. + To switch out of the selection or zoom mode, deselect the \uicontrol Select or + \uicontrol Zoom button. To move the application running in \QQV to the front, select the - \gui {Show Application on Top} button. + \uicontrol {Show Application on Top} button. */ diff --git a/doc/src/editors/creator-beautifier.qdoc b/doc/src/editors/creator-beautifier.qdoc index e2fe8c46fc..86605bb404 100644 --- a/doc/src/editors/creator-beautifier.qdoc +++ b/doc/src/editors/creator-beautifier.qdoc @@ -64,39 +64,39 @@ You might have to build the tools from sources for some platforms. - \li Select \gui Help > \gui {About Plugins} > \gui {C++} > - \gui Beautifier to enable the plugin. + \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} > + \uicontrol Beautifier to enable 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. \image beautifier_options.png - \li In the \gui {Artistic Style command}, \gui {Clang Format command}, - or \gui {Uncrustify command} field, specify the path to the tool + \li In the \uicontrol {Artistic Style command}, \uicontrol {Clang Format command}, + or \uicontrol {Uncrustify command} field, specify the path to the tool 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 options, they are applied from top down. \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 DISTFILES variable as the configuration file for the 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 the selected tool. - \li Select the \gui {Use customized style} option, and then - \gui Add to define your own style. + \li Select the \uicontrol {Use customized style} option, and then + \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, and context-sensitive help. For these features, you must have the tool installed. @@ -105,8 +105,8 @@ \endlist - \li Select \gui Tools > \gui Beautifier > \gui {Artistic Style}, - \gui ClangFormat, or \gui Uncrustify > \gui {Format Current File} + \li Select \uicontrol Tools > \uicontrol Beautifier > \uicontrol {Artistic Style}, + \uicontrol ClangFormat, or \uicontrol Uncrustify > \uicontrol {Format Current File} to format the currently open file. You can \l{Keyboard Shortcuts}{create keyboard shortcuts} for the @@ -114,9 +114,9 @@ \endlist - In addition to the \gui {Format Current File} command, ClangFormat provides - the \gui {Format Selected Text} command. If you select it when no text is + In addition to the \uicontrol {Format Current File} command, ClangFormat provides + 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 - the \gui {Format entire file if no text was selected} check box in the - \gui {Clang Format} options. + the \uicontrol {Format entire file if no text was selected} check box in the + \uicontrol {Clang Format} options. */ diff --git a/doc/src/editors/creator-clang-codemodel.qdoc b/doc/src/editors/creator-clang-codemodel.qdoc index 6b35d0b55a..e3f88564e4 100644 --- a/doc/src/editors/creator-clang-codemodel.qdoc +++ b/doc/src/editors/creator-clang-codemodel.qdoc @@ -77,7 +77,7 @@ can take a while. 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 code model plugin: @@ -169,16 +169,17 @@ \list 1 - \li Select \gui Help > \gui {About Plugins} > \gui {C++} > - \gui ClangCodeModel to enable the plugin. + \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} > + \uicontrol ClangCodeModel to enable 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. \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 diff --git a/doc/src/editors/creator-coding-edit-mode.qdoc b/doc/src/editors/creator-coding-edit-mode.qdoc index 67223821e6..793fd1bba8 100644 --- a/doc/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/src/editors/creator-coding-edit-mode.qdoc @@ -30,7 +30,7 @@ \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}. \section1 Using the Editor Toolbar @@ -44,17 +44,17 @@ Use the toolbar to navigate between open files and symbols in use. To browse backward or forward through your location history, click \inlineimage qtcreator-back.png - (\gui {Go Back}) and \inlineimage qtcreator-forward.png - (\gui {Go Forward}). + (\uicontrol {Go Back}) and \inlineimage qtcreator-forward.png + (\uicontrol {Go Forward}). - To go to any open file, select it from the \gui{Open files} drop-down menu (1). - Right-click the menu title and select \gui {Copy Full Path to Clipboard} to + To go to any open file, select it from the \uicontrol{Open files} drop-down menu (1). + 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. 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 - select \gui {Sort Alphabetically} to arrange the symbols in alphabetic + select \uicontrol {Sort Alphabetically} to arrange the symbols in alphabetic order. To jump to a line and column in the current file, select the line and column @@ -63,8 +63,8 @@ separated by a colon (:). To show the file encoding of the current file on the editor toolbar (4), - select \gui Tools > \gui Options > \gui {Text Editor} > \gui Display > - \gui {Display file encoding}. + select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} > \uicontrol Display > + \uicontrol {Display file encoding}. \note Other convenient ways of navigating in \QC are provided by the \l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts} @@ -82,21 +82,21 @@ \list \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 - (\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. \li To split the editor view into adjacent views, select - \gui Window > \gui{Split Side by Side}, press \key{Ctrl+E, 3}, or - select \gui {Split > Split Side by Side}. + \uicontrol Window > \uicontrol{Split Side by Side}, press \key{Ctrl+E, 3}, or + select \uicontrol {Split > Split Side by Side}. Side by side split command creates views to the right of the currently active editor view. \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 in the main window. For example, you can split this window, as well. @@ -104,16 +104,16 @@ \endlist - To move between split views and detached editor windows, select \gui Window - > \gui{Go to Next Split or Window} or press \key{Ctrl+E, O}. + To move between split views and detached editor windows, select \uicontrol Window + > \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 - 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 \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, - 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 @@ -121,7 +121,7 @@ \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. @@ -132,7 +132,7 @@ \image qtcreator-togglebookmark.png 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. 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 \key Alt while clicking the symbol. - To enable this moving function, select \gui Tools > \gui{Options} > - \gui{Text Editor} > \gui Behavior > \gui{Enable mouse navigation}. + To enable this moving function, select \uicontrol Tools > \uicontrol{Options} > + \uicontrol{Text Editor} > \uicontrol Behavior > \uicontrol{Enable mouse navigation}. 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, variables, include statements, and macros. 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 you to navigate from anywhere within a function body directly to the function declaration. @@ -163,9 +163,9 @@ 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} to follow the symbol in the next split. If necessary, the view is - automatically split. To change the default behavior, select \gui Tools > - \gui{Options} > \gui{Text Editor} > \gui Display, and then select - \gui{Always Open Links in Next Split}. Additional symbols are displayed and + automatically split. To change the default behavior, select \uicontrol Tools > + \uicontrol{Options} > \uicontrol{Text Editor} > \uicontrol Display, and then select + \uicontrol{Always Open Links in Next Split}. Additional symbols are displayed and switching between definition and declaration is done in another split. 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. @@ -173,8 +173,8 @@ \section1 Reparsing Externally Changed Files If source files are modified from outside \QC, the opened files will be - reparsed automatically. For all other files, you can use \gui{Tools} > - \gui{C++} > \gui{Reparse Externally Changed Files} to update the code + reparsed automatically. For all other files, you can use \uicontrol{Tools} > + \uicontrol{C++} > \uicontrol{Reparse Externally Changed Files} to update the code model. \section1 Inspecting the Code Model @@ -185,14 +185,14 @@ inspection. To view information about the C++ code model in the - \gui {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 {C++ Code Model Inspector} dialog and write it to a log file, select + \uicontrol Tools > \uicontrol C++ > \uicontrol {Inspect C++ Code Model} or press \key {Ctrl+Shift+F12}. \QC generates the code model inspection log file in a temporary folder. \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 - resolved to the wrong file, select \gui {Project Parts} > - \gui {Include Paths}. + resolved to the wrong file, select \uicontrol {Project Parts} > + \uicontrol {Include Paths}. */ diff --git a/doc/src/editors/creator-coding.qdoc b/doc/src/editors/creator-coding.qdoc index fe2373125c..709fb55e1f 100644 --- a/doc/src/editors/creator-coding.qdoc +++ b/doc/src/editors/creator-coding.qdoc @@ -38,7 +38,7 @@ Writing, editing, and navigating in source code are core tasks in 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. \li \l{Finding} @@ -65,7 +65,7 @@ You can change the fonts, colors, highlighting, and indentation. 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 @@ -82,7 +82,7 @@ \li \l{Comparing Files} 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} diff --git a/doc/src/editors/creator-diff-editor.qdoc b/doc/src/editors/creator-diff-editor.qdoc index c55712f87a..87ee9652bc 100644 --- a/doc/src/editors/creator-diff-editor.qdoc +++ b/doc/src/editors/creator-diff-editor.qdoc @@ -39,13 +39,13 @@ \list 1 - \li Select \gui Tools > \gui Diff. + \li Select \uicontrol Tools > \uicontrol Diff. \li Select two files to compare. \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 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 @@ -54,49 +54,49 @@ To view the differences in a unified view where changed rows are placed below each other, select \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 \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 > - \gui {Text Editor} > \gui {Font & Colors}. Create your own color scheme and + To change the default colors, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Text Editor} > \uicontrol {Font & Colors}. Create your own color scheme and select new colors for the following options: \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. - \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. - \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. - \li \gui {Diff Source Character} sets the color that indicates removed + \li \uicontrol {Diff Source Character} sets the color that indicates removed 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. - \li \gui {Diff Destination Character} sets the color that indicates + \li \uicontrol {Diff Destination Character} sets the color that indicates added characters. \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 - 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 synchronized. To use them independently of each other, select the \inlineimage qtcreator-synchronizefocus.png - (\gui {Synchronize Horizontal Scroll Bars}) button. + (\uicontrol {Synchronize Horizontal Scroll Bars}) button. If the files change outside \QC, select \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. */ diff --git a/doc/src/editors/creator-editors-options-text.qdoc b/doc/src/editors/creator-editors-options-text.qdoc index a4b51f5919..3d7b9919ce 100644 --- a/doc/src/editors/creator-editors-options-text.qdoc +++ b/doc/src/editors/creator-editors-options-text.qdoc @@ -31,7 +31,7 @@ \title Specifying Text Editor Settings 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" @@ -41,11 +41,11 @@ 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 the mouse button up or down. To disable the mouse wheel function, select - \gui {Tools > Options > Text Editor > Behavior} and deselect the - \gui {Enable scroll wheel zooming} check box. + \uicontrol {Tools > Options > Text Editor > Behavior} and deselect the + \uicontrol {Enable scroll wheel zooming} check box. 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. \section2 Defining Color Schemes @@ -58,17 +58,17 @@ \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. - \li In the \gui Background field, select the background + \li In the \uicontrol Background field, select the background 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. \endlist @@ -79,18 +79,18 @@ \section2 File Encoding - To define the default file encoding, select \gui Tools > \gui Options > - \gui {Text Editor} > \gui Behavior, and then select a suitable option in - \gui {Default encoding}. + To define the default file encoding, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Text Editor} > \uicontrol Behavior, and then select a suitable option in + \uicontrol {Default encoding}. 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. - However, the \gui {Default encoding} field still displays the value - \gui System if the default system encoding is set to UTF-8. + encoding was changed from \uicontrol System to \uicontrol UTF-8 in \QC version 2.6. + However, the \uicontrol {Default encoding} field still displays the value + \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. 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.} 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 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. */ diff --git a/doc/src/editors/creator-editors-options.qdoc b/doc/src/editors/creator-editors-options.qdoc index cf77040f6b..fa640e50e8 100644 --- a/doc/src/editors/creator-editors-options.qdoc +++ b/doc/src/editors/creator-editors-options.qdoc @@ -31,11 +31,11 @@ \title Configuring the Editor \QC allows you to configure the text editor to suit your specific - needs. To configure the editor, select \gui Tools > \gui{Options} > - \gui{Text Editor}. + needs. To configure the editor, select \uicontrol Tools > \uicontrol{Options} > + \uicontrol{Text Editor}. 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}. You can also specify indentation settings separately for C++ and QML files @@ -47,28 +47,28 @@ \list \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} {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 - whitespace, and mouse operations} in \gui Behavior. + whitespace, and mouse operations} in \uicontrol Behavior. \li Set various display properties, for example, \l{Highlighting and folding blocks} {highlighting and folding blocks}, text wrapping or \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 - \gui Snippets. + \uicontrol Snippets. \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 diff --git a/doc/src/editors/creator-editors.qdoc b/doc/src/editors/creator-editors.qdoc index b792b6cf05..6e5ed538ff 100644 --- a/doc/src/editors/creator-editors.qdoc +++ b/doc/src/editors/creator-editors.qdoc @@ -48,7 +48,7 @@ \endlist 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 C++, QML, or JavaScript. @@ -78,35 +78,35 @@ \list 1 - \li Select \gui {Tools > Options > Text Editor > Generic + \li Select \uicontrol {Tools > Options > Text Editor > Generic Highlighter}. \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. - \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. \image qtcreator-manage-definitions.png "Download Definitions dialog" \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 definition files. - \li Click \gui Autodetect to allow \QC to look for highlight - definition files on your system, or click \gui Browse to locate + \li Click \uicontrol Autodetect to allow \QC to look for highlight + definition files on your system, or click \uicontrol Browse to locate 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 specified files are not found. - \li Click \gui OK to save your changes. + \li Click \uicontrol OK to save your changes. \endlist @@ -118,22 +118,22 @@ \image qtcreator-blockhighlighting.png - To enable block highlighting, select \gui Tools > \gui{Options} > - \gui{Text Editor} > \gui Display > \gui{Highlight blocks}. + To enable block highlighting, select \uicontrol Tools > \uicontrol{Options} > + \uicontrol{Text Editor} > \uicontrol Display > \uicontrol{Highlight blocks}. 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 figure above, the folding markers are located between the line number and the text pane. - To show the folding markers, select \gui Tools > \gui{Options} > - \gui{Text Editor} > \gui Display > \gui{Display folding markers}. This + To show the folding markers, select \uicontrol Tools > \uicontrol{Options} > + \uicontrol{Text Editor} > \uicontrol Display > \uicontrol{Display folding markers}. This option is enabled by default. 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 - the braces, select \gui {Tools > Options > Text Editor > Display} and - deselect \gui {Animate matching parentheses}. + the braces, select \uicontrol {Tools > Options > Text Editor > Display} and + deselect \uicontrol {Animate matching parentheses}. */ @@ -194,9 +194,9 @@ \section1 Checking JavaScript and QML Syntax - To run the checks, select \gui {Tools > QML/JS > Run Checks} or press - \key Ctrl+Shift+C. The results are shown in the \gui {QML Analysis} - filter of the \gui {Issues} output pane. + To run the checks, select \uicontrol {Tools > QML/JS > Run Checks} or press + \key Ctrl+Shift+C. The results are shown in the \uicontrol {QML Analysis} + filter of the \uicontrol {Issues} output pane. \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 \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} > - \gui {Reset Code Model}. + To reset the code model, select \uicontrol Tools > \uicontrol {QML/JS} > + \uicontrol {Reset Code Model}. 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 @@ -774,12 +774,13 @@ When completion is invoked manually, \QC completes the common prefix of the list of suggestions. This is especially useful for classes with several similarly named members. To disable this functionality, uncheck - \gui{Autocomplete common prefix} in the code completion preferences. - Select \gui Tools > \gui{Options} > \gui{Text Editor} > \gui Completion. + \uicontrol{Autocomplete common prefix} in the code completion preferences. + Select \uicontrol Tools > \uicontrol{Options} > \uicontrol{Text Editor} + > \uicontrol Completion. By default, code completion considers only the first letter case-sensitive. 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 @@ -864,7 +865,7 @@ Code snippets specify C++ or QML code constructs. You can add, modify, 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" @@ -884,7 +885,7 @@ \section3 Adding and Editing Snippets 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 you write code. Also specify a text string or C++ or QML code construct in 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 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}. \section3 Removing Snippets @@ -948,15 +949,15 @@ can restore them. 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}. \section3 Resetting Snippets 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. */ @@ -976,13 +977,13 @@ \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 @@ -992,57 +993,57 @@ \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" - \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. - \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. - \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 you paste a post. - \li Select the \gui {Display Output pane after sending a post} to - display the URL in the \gui {General Messages} output pane when you + \li Select the \uicontrol {Display Output pane after sending a post} to + display the URL in the \uicontrol {General Messages} output pane when you paste a post. \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. You have to delete obsolete files from the drive manually. \section1 Using Code Pasting Services - To paste a snippet of code onto the server, select \gui{Tools} > - \gui{Code Pasting} > \gui{Paste Snippet} or press \key{Alt+C,Alt+P}. + To paste a snippet of code onto the server, select \uicontrol{Tools} > + \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 - 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 > - \gui {Code Pasting} > \gui {Paste Snippet}. + To paste any content that you copied to the clipboard, select \uicontrol Tools > + \uicontrol {Code Pasting} > \uicontrol {Paste Snippet}. - To fetch a snippet of code from the server, select \gui{Tools} > - \gui{Code Pasting} > \gui{Fetch Snippet} or press \key{Alt+C,Alt+F}. Select + To fetch a snippet of code from the server, select \uicontrol{Tools} > + \uicontrol{Code Pasting} > \uicontrol{Fetch Snippet} or press \key{Alt+C,Alt+F}. Select the snippet to fetch from the list. - To fetch the content stored at an URL, select \gui Tools > - \gui {Code Pasting} > \gui {Fetch from URL}. + To fetch the content stored at an URL, select \uicontrol Tools > + \uicontrol {Code Pasting} > \uicontrol {Fetch from URL}. 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 - 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 - \gui{Tools} > \gui{Code Pasting} > \gui{Paste Snippet}. The reviewers can - retrieve the code snippet by selecting \gui{Tools > Code Pasting > + \uicontrol{Tools} > \uicontrol{Code Pasting} > \uicontrol{Paste Snippet}. The reviewers can + retrieve the code snippet by selecting \uicontrol{Tools > Code Pasting > 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 - To record a text editing macro, select \gui {Tools > Macros > Record Macro} - or press \key {Alt+(}. To stop recording, select \gui {Tools > Macros > + To record a text editing macro, select \uicontrol {Tools > Macros > Record Macro} + or press \key {Alt+(}. To stop recording, select \uicontrol {Tools > Macros > Stop Recording Macro} or press \key {Alt+)}. \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}. - 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 \l{Configuring Keyboard Shortcuts}. You can also use the \c rm locator filter to run a macro. For more 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}. */ @@ -1087,43 +1088,43 @@ \title Using FakeVim Mode - In the \gui{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 - \gui{Edit} > \gui{Advanced} > \gui{Use Vim-style Editing} or press + 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 \uicontrol{FakeVim} mode, select + \uicontrol{Edit} > \uicontrol{Advanced} > \uicontrol{Use Vim-style Editing} or press \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 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. - To map commands entered on the \gui{FakeVim} command line to actions of the - \QC core, select \gui{Tools} > \gui{Options} > \gui{FakeVim} > - \gui{Ex Command Mapping}. + To map commands entered on the \uicontrol{FakeVim} command line to actions of the + \QC core, select \uicontrol{Tools} > \uicontrol{Options} > \uicontrol{FakeVim} > + \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 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} > - \gui{Options} > \gui FakeVim > \gui{General}. + To make changes to the Vim-style settings, select \uicontrol{Tools} > + \uicontrol{Options} > \uicontrol FakeVim > \uicontrol{General}. \image qtcreator-fakevim-options.png "FakeVim options" To preselect the indentation settings specified for the text editor, select - \gui {Copy Text Editor Settings}. To preselect the Qt coding style, select - \gui {Set Qt Style}. To preselect a simple indentation style, select - \gui {Set Plain Style}. You can then change any of the preselected settings. + \uicontrol {Copy Text Editor Settings}. To preselect the Qt coding style, select + \uicontrol {Set Qt Style}. To preselect a simple indentation style, select + \uicontrol {Set Plain Style}. You can then change any of the preselected settings. - To use a Vim-style color scheme, select \gui {Tools > Options > - Text Editor > Fonts & Color}. In the \gui {Color Scheme} list, select - \gui {Vim (dark)}. + To use a Vim-style color scheme, select \uicontrol {Tools > Options > + Text Editor > Fonts & Color}. In the \uicontrol {Color Scheme} list, select + \uicontrol {Vim (dark)}. - To quit the FakeVim mode, unselect \gui{Tools} > \gui{Options} > - \gui{FakeVim} > \gui {Use FakeVim} or press \key{Alt+V,Alt+V}. + To quit the FakeVim mode, unselect \uicontrol{Tools} > \uicontrol{Options} > + \uicontrol{FakeVim} > \uicontrol {Use FakeVim} or press \key{Alt+V,Alt+V}. 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. */ @@ -1163,16 +1164,16 @@ \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 - and click \gui Copy. + \li In the \uicontrol {Current settings} field, select the settings to modify + and click \uicontrol Copy. \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" @@ -1201,7 +1202,7 @@ 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}. \section1 Indenting QML Files @@ -1210,16 +1211,16 @@ \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 - and click \gui Copy. + \li In the \uicontrol {Current settings} field, select the settings to modify + and click \uicontrol Copy. \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" @@ -1228,18 +1229,18 @@ You can specify how to interpret the \key Tab key presses and how to align 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}. \section1 Indenting Other Text Files 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" - To specify different settings for a particular project, select \gui Projects - > \gui Editor. + To specify different settings for a particular project, select \uicontrol Projects + > \uicontrol Editor. You can specify how to interpret the \key Tab and \key Backspace key presses and how to align continuation lines. @@ -1266,8 +1267,8 @@ \section2 Specifying Tabs and Indentation - You can specify tab policy and tab size in the \gui Typing group. In the - \gui {Tab policy} field, select whether to use only spaces or only tabs for + You can specify tab policy and tab size in the \uicontrol Typing group. In the + \uicontrol {Tab policy} field, select whether to use only spaces or only tabs for indentation, or to use a mixture of them. 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. 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. - To always use spaces for alignment, select \gui {With Spaces}. To follow the - \gui {Tab policy}, select \gui {With Regular Indent}. + To always use spaces for alignment, select \uicontrol {With Spaces}. To follow the + \uicontrol {Tab policy}, select \uicontrol {With Regular Indent}. \section2 Specifying Typing Options 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 - \gui Typing group. To disable automatic indentation, deselect the - \gui {Enable automatic indentation} check box. + \uicontrol Typing group. To disable automatic indentation, deselect the + \uicontrol {Enable automatic indentation} check box. You can specify how the indentation is decreased when you press - \gui Backspace in the \gui {Backspace indentation} field. To go back one - space at a time, select \gui None. To decrease indentation in leading white - space by one level, select \gui {Follows Previous Indents}. To move back one + \uicontrol Backspace in the \uicontrol {Backspace indentation} field. To go back one + space at a time, select \uicontrol None. To decrease indentation in leading white + 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 - \gui Unindents. + \uicontrol Unindents. You can specify whether the \key Tab key automatically indents text when you - press it. To automatically indent text, select \gui Always in the - \gui {Tab key performs auto-indent} field. To only indent text when the - cursor is located within leading white space, select \gui {In Leading White + press it. To automatically indent text, select \uicontrol Always in the + \uicontrol {Tab key performs auto-indent} field. To only indent text when the + cursor is located within leading white space, select \uicontrol {In Leading White Space}. \section1 Specifying Settings for Content @@ -1327,8 +1328,8 @@ \section1 Specifying Alignment To align continuation lines to tokens after assignments, such as = or - +=, select the \gui {Align after assignments} check box. You can specify - additional settings for aligning continuation lines in the \gui General + +=, select the \uicontrol {Align after assignments} check box. You can specify + additional settings for aligning continuation lines in the \uicontrol General tab. 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 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 functions and pointers to arrays. @@ -1363,63 +1364,63 @@ \list 1 - \li Press \key Ctrl+F or select \gui Edit > \gui Find/Replace > - \gui{Find/Replace}. + \li Press \key Ctrl+F or select \uicontrol Edit > \uicontrol Find/Replace > + \uicontrol{Find/Replace}. \li Enter the text you are looking for. If the text is found, all occurrences are highlighted as you type. \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 \inlineimage qtcreator-previous.png - (\gui {Find Previous}), or press \key Shift+F3. + (\uicontrol {Find Previous}), or press \key Shift+F3. \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: \list \li To make your search case sensitive, select - \gui {Case Sensitive}. + \uicontrol {Case Sensitive}. \li To search only whole words, select - \gui {Whole Words Only}. + \uicontrol {Whole Words Only}. \li To search using regular expressions, select - \gui {Regular Expressions}. + \uicontrol {Regular Expressions}. Regular expressions used in \QC are modeled on Perl regular expressions. For more information on using regular expressions, see the documentation for the QRegExp Class. \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. To replace occurrences of the existing text, enter the new text in the - \gui{Replace with} field. + \uicontrol{Replace with} field. \list \li To replace the selected occurrence and move to the next one, - click \gui {Find Next} + click \uicontrol {Find Next} or press \key Ctrl+=. \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 - 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 - 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 case of the occurrence will be conserved, according to the following rules: @@ -1445,40 +1446,40 @@ \list 1 - \li Press \key Ctrl+Shift+F or select \gui Edit > \gui Find/Replace > - \gui{Advanced Find} > \gui{Open Advanced Find}. + \li Press \key Ctrl+Shift+F or select \uicontrol Edit > \uicontrol Find/Replace > + \uicontrol{Advanced Find} > \uicontrol{Open Advanced Find}. \li Select the scope of your search: \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. 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. \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. - \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. - \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 - \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 A list of files containing the searched text is displayed in the - \gui{Search Results} pane. + \uicontrol{Search Results} pane. \list @@ -1488,7 +1489,7 @@ \li To go to an occurrence, double-click it. \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 @@ -1497,7 +1498,7 @@ The search results are stored in the search history from which you can 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}. */ @@ -1537,9 +1538,9 @@ \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 @@ -1558,14 +1559,14 @@ \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 either from files listed as part of the project or from all files that are used by the code, such as include files. \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. \image qtcreator-refactoring-find.png @@ -1577,13 +1578,13 @@ \list \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 \inlineimage qtcreator-forward.png and \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 \inlineimage qtcreator-expand.png @@ -1601,28 +1602,28 @@ \list 1 \li In the editor, place the cursor on the symbol you would like to - change and select \gui Tools > \gui C++ > - \gui{Rename Symbol Under Cursor} or \gui Tools > \gui QML/JS > - \gui{Rename Symbol Under Cursor}. Alternatively, press + change and select \uicontrol Tools > \uicontrol C++ > + \uicontrol{Rename Symbol Under Cursor} or \uicontrol Tools > \uicontrol QML/JS > + \uicontrol{Rename Symbol Under Cursor}. Alternatively, press \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. \image qtcreator-refactoring-replace.png \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. \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. \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 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, 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. - 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. \section2 Refactoring C++ Code @@ -1971,7 +1972,7 @@ \li Extract Function \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 - the \gui {Extract Function Refactoring} dialog. + the \uicontrol {Extract Function Refactoring} dialog. \li Block of code selected \row \li Extract Constant as Function Parameter @@ -2268,9 +2269,9 @@ \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 \l{Using the Editor Toolbar}{editor toolbar}. @@ -2409,15 +2410,15 @@ \list 1 \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. - \li Select a filter, and then select \gui Edit. + \li Select a filter, and then select \uicontrol Edit. \li Specify the prefix string. \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 \l{Adding Web Search Engines}. @@ -2426,7 +2427,7 @@ \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, cplusplus.com, and Wikipedia are configured by default. @@ -2439,18 +2440,18 @@ \list 1 - \li Select \gui {Tools > Options > Environment > Locator > + \li Select \uicontrol {Tools > Options > Environment > Locator > Web Search (prefix: r) > 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" \li Double-click the new entry to specify a URL and a search command. For example, http://www.google.com/search?q=%1. - \li Click \gui OK. + \li Click \uicontrol OK. \endlist @@ -2464,14 +2465,14 @@ \list 1 - \li In the locator, select \gui {Options > Configure} to open the - \gui Locator options. + \li In the locator, select \uicontrol {Options > Configure} to open the + \uicontrol Locator options. \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 @@ -2486,7 +2487,7 @@ \li Specify the prefix string. To show only results matching this filter, select - \gui{Limit to prefix}. + \uicontrol{Limit to prefix}. \image qtcreator-navigate-customfilter.png @@ -2503,16 +2504,16 @@ all default filters is updated as you write your code. By default, \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. To set a new cache update time: \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 diff --git a/doc/src/editors/creator-mime-types.qdoc b/doc/src/editors/creator-mime-types.qdoc index 9280fa8128..55db17dd76 100644 --- a/doc/src/editors/creator-mime-types.qdoc +++ b/doc/src/editors/creator-mime-types.qdoc @@ -56,35 +56,35 @@ \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" - \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. - \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" - \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. - \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, because it might cause problems when opening files in \QC. - \li Click \gui OK. + \li Click \uicontrol OK. \endlist 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 time you start \QC. diff --git a/doc/src/howto/creator-external-tools.qdoc b/doc/src/howto/creator-external-tools.qdoc index 77f1569d6c..1d29cd5ef4 100644 --- a/doc/src/howto/creator-external-tools.qdoc +++ b/doc/src/howto/creator-external-tools.qdoc @@ -45,15 +45,15 @@ To synchronize translation source (TS) files from a translator with the application code, - select \gui {Tools > External > Text > Linguist > Update Translations + select \uicontrol {Tools > External > Text > Linguist > Update Translations (lupdate)}. 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)}. 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}. 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 for viewing and testing while you are developing an application. - To preview the currently active QML file, select \gui Tools > \gui External - > \gui {Qt Quick} > \gui {Qt Quick 1 Preview (qmlviewer)} or - \gui {Qt Quick 2 Preview (qmlscene)}. + To preview the currently active QML file, select \uicontrol Tools > + \uicontrol External > \uicontrol {Qt Quick} > \uicontrol {Qt Quick 1 Preview + (qmlviewer)} or \uicontrol {Qt Quick 2 Preview (qmlscene)}. \section1 Using External Text Editors You can open files for editing in the default text editor for your system: Notepad on Windows and vi on Linux and OS X. To open the file you are currently viewing in an external editor, select - \gui Tools > \gui External > \gui Text > \gui {Edit with Notepad} or - \gui {Edit with vi}, depending on your system. + \uicontrol Tools > \uicontrol External > \uicontrol Text > + \uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on + your system. \QC looks for the editor path in the PATH environment variable of your operating system. \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 returns it in alphabetic order. By default, the output replaces the 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}. \section1 Configuring External Tools 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: \list 1 - \li Select \gui {Tools > External > Configure}. + \li Select \uicontrol {Tools > External > Configure}. - \li Select \gui {Add > Add Tool} - to add a new tool. You can also select \gui {Add Category} to add a + \li Select \uicontrol {Add > Add Tool} + to add a new tool. You can also select \uicontrol {Add Category} to add a 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 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. - \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. - \li In the \gui {Output pane}, select how to handle output from the - tool. You can ignore the output, view it in the \gui {General + \li In the \uicontrol {Output pane}, select how to handle output from the + tool. You can ignore the output, view it in the \uicontrol {General Messages} output pane, or replace the selected text with the 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. - \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 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. \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 - 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 user configuration folder. For example, diff --git a/doc/src/howto/creator-help.qdoc b/doc/src/howto/creator-help.qdoc index f9ef47c271..4ea02b5eee 100644 --- a/doc/src/howto/creator-help.qdoc +++ b/doc/src/howto/creator-help.qdoc @@ -35,7 +35,7 @@ \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 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. The documentation is displayed in a 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 - \gui Help mode, select \gui Tools > \gui Options > \gui Help. + \uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help. \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. \image qtcreator-context-sensitive-help.png \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 > On Shift+Mouseover}. You can still view the tooltips by pressing and holding down the \key Shift key. 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 \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: \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. - \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. - \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. - \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. - \li \gui Search to search from all the installed documents. + \li \uicontrol Search to search from all the installed documents. \endlist \section2 Adding Bookmarks to Help Pages 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 folders in the view. @@ -108,21 +108,21 @@ \li Click the \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. \endlist - To import and export bookmarks, select \gui {Tools > Options > Help > - General Settings > Import} or \gui Export. + To import and export bookmarks, select \uicontrol {Tools > Options > Help > + General Settings > Import} or \uicontrol Export. \section2 Full-text Search - In the \gui Search pane, you can use full-text search for finding a - particular word in all the installed documents. In the \gui {Search for} - field, enter the term you are looking for, and select the \gui Search + In the \uicontrol Search pane, you can use full-text search for finding a + particular word in all the installed documents. In the \uicontrol {Search for} + 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 is sorted by the number of search hits that the documents contain. Select a document in the list to open it. @@ -147,20 +147,20 @@ \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 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}. Combine options to improve the search results. 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. If you cannot find words that you know are there, indexing might not have been completed for some reason. To regenerate the index, click \inlineimage qtcreator-regenerate-index.png - (\gui {Regenerate Index}). + (\uicontrol {Regenerate Index}). 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 @@ -168,7 +168,7 @@ \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: \list 1 @@ -178,8 +178,8 @@ For information on how to prepare your documentation and create a .qch file, see \l{The Qt Help Framework}. - \li To add the .qch file to \QC, select \gui Tools > \gui Options > - \gui Help > \gui Documentation > \gui Add. + \li To add the .qch file to \QC, select \uicontrol Tools > \uicontrol Options > + \uicontrol Help > \uicontrol Documentation > \uicontrol Add. \endlist @@ -190,32 +190,32 @@ space, the help opens in the full-screen help mode. 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 - in the \gui {On context help} field. To detach the help window, select - \gui {Always Show Help in External Window}. + in the \uicontrol {On context help} field. To detach the help window, select + \uicontrol {Always Show Help in External Window}. \section1 Selecting the Start Page - You can select the page to display when you open the \gui Help mode in the - \gui {Tools > Options > Help > General Settings > On help start} field. + You can select the page to display when you open the \uicontrol Help mode in the + \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, - select the \gui {Show My Tabs from Last Session} option. However, Web pages - are not opened, because loading them would slow down opening the \gui Help + select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages + are not opened, because loading them would slow down opening the \uicontrol Help mode. - To display a particular page, select \gui {Show My Home Page}, and specify - the page in the \gui {Home Page} field. + To display a particular page, select \uicontrol {Show My Home Page}, and specify + the page in the \uicontrol {Home Page} field. - To display a blank page, select the \gui {Show a Blank Page} option. You can - also select the \gui {Use Blank Page} button to set a blank page as your + To display a blank page, select the \uicontrol {Show a Blank Page} option. You can + also select the \uicontrol {Use Blank Page} button to set a blank page as your home page. \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 - \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. \image qtcreator-help-filters.png "Help filters" @@ -231,25 +231,25 @@ \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. \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. \endlist - To modify filters, select a filter in \gui Filters, select the attributes, - and then click \gui Apply. + To modify filters, select a filter in \uicontrol Filters, select the attributes, + 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. */ diff --git a/doc/src/howto/creator-keyboard-shortcuts.qdoc b/doc/src/howto/creator-keyboard-shortcuts.qdoc index dc375211ac..ebe7c59a48 100644 --- a/doc/src/howto/creator-keyboard-shortcuts.qdoc +++ b/doc/src/howto/creator-keyboard-shortcuts.qdoc @@ -34,9 +34,9 @@ process. 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 - 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. \image qtcreator-keyboard-shortcuts.png @@ -59,14 +59,15 @@ \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 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. - \li To revert to the default shortcut, select \gui Reset. + \li To revert to the default shortcut, select \uicontrol Reset. \endlist @@ -74,12 +75,12 @@ \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 you want to import. \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. \endlist @@ -159,40 +160,40 @@ \li Previous open document in history \li Ctrl+Tab \row - \li Activate \gui Locator + \li Activate \uicontrol Locator \li Ctrl+K \row - \li Switch to \gui Welcome mode + \li Switch to \uicontrol Welcome mode \li Ctrl+1 \row - \li Switch to \gui Edit mode + \li Switch to \uicontrol Edit mode \li Ctrl+2 \row - \li Switch to \gui Design mode + \li Switch to \uicontrol Design mode \li Ctrl+3 \row - \li Switch to \gui Debug mode + \li Switch to \uicontrol Debug mode \li Ctrl+4 \row - \li Switch to \gui Projects mode + \li Switch to \uicontrol Projects mode \li Ctrl+5 \row - \li Switch to \gui Analyze mode + \li Switch to \uicontrol Analyze mode \li Ctrl+6 \row - \li Switch to \gui Help mode + \li Switch to \uicontrol Help mode \li Ctrl+7 \row - \li Toggle \gui{Issues} pane + \li Toggle \uicontrol{Issues} pane \li Alt+1 (Cmd+1 on OS X) \row - \li Toggle \gui{Search Results} pane + \li Toggle \uicontrol{Search Results} pane \li Alt+2 (Cmd+2 on OS X) \row - \li Toggle \gui{Application Output} pane + \li Toggle \uicontrol{Application Output} pane \li Alt+3 (Cmd+3 on OS X) \row - \li Toggle \gui{Compile Output} pane + \li Toggle \uicontrol{Compile Output} pane \li Alt+4 (Cmd+4 on OS X) \row \li Toggle other output panes @@ -200,13 +201,13 @@ Where the number is the number of the output pane. \row - \li Activate \gui Bookmarks pane + \li Activate \uicontrol Bookmarks pane \li Alt+M \row - \li Activate \gui{File System} pane + \li Activate \uicontrol{File System} pane \li Alt+Y \row - \li Activate \gui{Open Documents} pane + \li Activate \uicontrol{Open Documents} pane \li Alt+O \row \li Maximize output panes @@ -218,7 +219,7 @@ \li Move to previous item in output panes \li Shift+F6 \row - \li Activate \gui Projects pane + \li Activate \uicontrol Projects pane \li Alt+X \row \li Full screen @@ -230,9 +231,9 @@ \li Undo \li Ctrl+Z \row - \li Move to \gui Edit mode + \li Move to \uicontrol Edit mode - In \gui Edit mode: + In \uicontrol Edit mode: \list \li The first press moves focus to the editor \li The second press closes secondary windows @@ -570,19 +571,19 @@ \li View context-sensitive help \li F1 \row - \li Activate contents in \gui Help mode + \li Activate contents in \uicontrol Help mode \li Ctrl+T \row - \li Add bookmark in \gui Help mode + \li Add bookmark in \uicontrol Help mode \li Ctrl+M \row - \li Activate index in \gui Help mode + \li Activate index in \uicontrol Help mode \li Ctrl+I \row \li Reset font size \li Ctrl+0 \row - \li Activate search in \gui Help mode + \li Activate search in \uicontrol Help mode \li Ctrl+S \endtable diff --git a/doc/src/howto/creator-sessions.qdoc b/doc/src/howto/creator-sessions.qdoc index 34235b9c07..2e7511a237 100644 --- a/doc/src/howto/creator-sessions.qdoc +++ b/doc/src/howto/creator-sessions.qdoc @@ -32,7 +32,7 @@ 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, - 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 become a part of the session: @@ -61,17 +61,17 @@ on the first project, open the saved session. \QC opens the projects and files that belong to the session. - To create a new session or remove existing sessions, select \gui File > - \gui{Session Manager}. + To create a new session or remove existing sessions, select \uicontrol File > + \uicontrol{Session Manager}. \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 was created the last time you exited \QC. When you launch \QC, a list of existing sessions is displayed in the - \gui Welcome mode. + \uicontrol Welcome mode. \image qtcreator-welcome-session.png diff --git a/doc/src/howto/creator-task-lists.qdoc b/doc/src/howto/creator-task-lists.qdoc index ec6b05d1aa..82932021f9 100644 --- a/doc/src/howto/creator-task-lists.qdoc +++ b/doc/src/howto/creator-task-lists.qdoc @@ -32,7 +32,7 @@ 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 - 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 easy to generate using scripts. The scripts can either convert reports from @@ -43,14 +43,14 @@ \section1 Managing Task List Entries - To open task list files in the \gui Issues pane, choose \gui File > - \gui Open. Right-click a task list entry to open a context menu that + To open task list files in the \uicontrol Issues pane, choose \uicontrol File > + \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 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 - changes, select \gui {Stop Monitoring}. + changes, select \uicontrol {Stop Monitoring}. \section1 Task List File Format diff --git a/doc/src/howto/creator-tips.qdoc b/doc/src/howto/creator-tips.qdoc index e94f749594..ba30fd33cc 100644 --- a/doc/src/howto/creator-tips.qdoc +++ b/doc/src/howto/creator-tips.qdoc @@ -37,13 +37,13 @@ \list - \li \gui Welcome mode \key Ctrl+1 - \li \gui Edit mode \key Ctrl+2 - \li \gui Design mode \key Ctrl+3 - \li \gui Debug mode \key Ctrl+4 - \li \gui Projects mode \key Ctrl+5 - \li \gui Analyze mode \key Ctrl+6 - \li \gui Help mode \key Ctrl+7 + \li \uicontrol Welcome mode \key Ctrl+1 + \li \uicontrol Edit mode \key Ctrl+2 + \li \uicontrol Design mode \key Ctrl+3 + \li \uicontrol Debug mode \key Ctrl+4 + \li \uicontrol Projects mode \key Ctrl+5 + \li \uicontrol Analyze mode \key Ctrl+6 + \li \uicontrol Help mode \key Ctrl+7 \endlist @@ -56,16 +56,16 @@ 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+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 location in that file by pressing \key {Alt+Left}. \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. - If you already are in the \gui Edit mode: + If you already are in the \uicontrol Edit mode: \list @@ -77,8 +77,8 @@ \section1 Using the Filter in Options Dialog - To find specific settings you require in \gui{Tools} > \gui{Options} - use the filter located at the top left of the \gui Options dialog box. + To find specific settings you require in \uicontrol{Tools} > \uicontrol{Options} + use the filter located at the top left of the \uicontrol Options dialog box. \section1 Opening Output Panes @@ -90,18 +90,18 @@ \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 - To open the other output panes, such as \gui{General Messages} and - \gui{Version Control}, select \gui Window > \gui {Output Panes}. The menu + To open the other output panes, such as \uicontrol{General Messages} and + \uicontrol{Version Control}, select \uicontrol Window > \uicontrol {Output Panes}. The menu items also display the keyboard shortcuts that you can use. 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 or the tooltip for a button. - To customize, import or export keyboard shortcuts, select \gui Tools > - \gui Options > \gui Environment > \gui Keyboard. + To customize, import or export keyboard shortcuts, select \uicontrol Tools > + \uicontrol Options > \uicontrol Environment > \uicontrol Keyboard. \section1 Running \QC From Command Line @@ -128,7 +128,7 @@ \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 or press \key Alt+0 (\key Cmd+0 on OS X). @@ -138,11 +138,11 @@ \section1 Moving To Symbols 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}. 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, 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 find all other objects connected to one of your object's slots using - Qt's signals and slots mechanism, select \gui Tools > \gui Options - > \gui{Debugger} > \gui{Locals and Expressions} > - \gui{Use Debugging Helper}. + Qt's signals and slots mechanism, select \uicontrol Tools > \uicontrol Options + > \uicontrol{Debugger} > \uicontrol{Locals and Expressions} > + \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 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}. \section1 Displaying Low Level Data @@ -175,10 +175,10 @@ To switch off the debugging helpers: \list 1 - \li Select \gui Tools > \gui Options > \gui Debugger > - \gui{Locals and Expressions}. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Debugger > + \uicontrol{Locals and Expressions}. - \li Uncheck the \gui{Use Debugging Helper} checkbox. + \li Uncheck the \uicontrol{Use Debugging Helper} checkbox. \endlist @@ -189,39 +189,40 @@ \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. \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. You can expand pinned tooltips to view their full content. \image qtcreator-pin-tooltip.png 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. \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. 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 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}. \section1 Adding a License Header Template for C++ Code 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 new file: diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index 8ef59bd166..acf288d416 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -30,7 +30,7 @@ \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 @@ -65,10 +65,10 @@ {corresponding keyboard shortcut}. 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) - and \gui Design mode (2). + The following image displays an example application in \uicontrol Edit mode (1) + and \uicontrol Design mode (2). \image qtcreator-qt-quick-editors.png "Edit mode and Design mode" @@ -76,37 +76,37 @@ \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. - \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 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. - \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 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. - \li \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation. + \li \uicontrol{\l{Getting Help}{Help}} mode for viewing Qt documentation. \endlist - Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} > - \gui {Start Debugging} > \gui {Start Debugging} automatically switches to - \gui {Debug} mode. + Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} > + \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to + \uicontrol {Debug} mode. \section1 Browsing Project Contents - The sidebar is available in the \gui Edit and \gui Debug modes, and with a - different set of views in the \gui Design mode. Use the + The sidebar is available in the \uicontrol Edit and \uicontrol Debug modes, and with a + different set of views in the \uicontrol Design mode. Use the sidebar to browse projects, files, and bookmarks, and to view the class hierarchy. @@ -116,25 +116,25 @@ \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. - \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. - \li \gui {Class View} shows the class hierarchy of the currently + \li \uicontrol {Class View} shows the class hierarchy of the currently 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. - \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. \endlist @@ -147,15 +147,15 @@ \list \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). \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 \inlineimage qtcreator-closesidebar.png - (\gui {Close}). + (\uicontrol {Close}). \endlist @@ -188,15 +188,15 @@ \li To hide the categories and sort project files alphabetically, click \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 - 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 currently opened in the editor, click \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 file name. @@ -206,51 +206,51 @@ 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 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 - If you cannot see a file in the \gui Projects view, switch to the - \gui {File System} view, which shows all the files in the file system. + If you cannot see a file in the \uicontrol Projects view, switch to the + \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 - opened in the editor, select \gui {Synchronize with Editor}. + opened in the editor, select \uicontrol {Synchronize with Editor}. \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 \inlineimage qtcreator-show-subprojects.png - (\gui {Show Subprojects}). + (\uicontrol {Show Subprojects}). To visit all parts of a namespace, double-click on the namespace item multiple times. \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 - \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}. \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 \section2 Viewing Type Hierarchy 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 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}. \section1 Viewing Output @@ -259,73 +259,73 @@ \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 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 - \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 - 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. - 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 - \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. \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 - \li \gui Analyzer - Errors encountered while running the + \li \uicontrol Analyzer - Errors encountered while running the \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 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. - \li \gui Compile - Selected output from the compiler. Open the - \gui {Compile Output} pane for more detailed information. + \li \uicontrol Compile - Selected output from the compiler. Open the + \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. - \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. - \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. - \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} {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} {code syntax and validation checks} @@ -333,7 +333,7 @@ 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 - \gui {Filter Tree} + \uicontrol {Filter Tree} and then select a filter. \image qtcreator-build-issues.png @@ -345,18 +345,18 @@ annotation view of the line that causes the error message. 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. - To view more information about an issue in the \gui {Compile Output} pane, - select \gui {Show Output} in the context menu. + To view more information about an issue in the \uicontrol {Compile Output} pane, + select \uicontrol {Show Output} in the context menu. To jump from one issue to the next or previous one, press \key F6 and \key Shift+F6. \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: \image qtcreator-search-results.png "Search Results output pane" @@ -371,7 +371,7 @@ \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. \image qtcreator-application-output.png @@ -381,20 +381,20 @@ \section2 Compile Output - The \gui{Compile Output} pane provides all output from the compiler. - The \gui{Compile Output} is a more detailed version of information - displayed in the \gui{Issues} pane. + The \uicontrol{Compile Output} pane provides all output from the compiler. + The \uicontrol{Compile Output} is a more detailed version of information + displayed in the \uicontrol{Issues} pane. \image qtcreator-compile-pane.png Double-click on a file name in an error message to open the file in the 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 - 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 values temporarily, without editing the source, and view the results in the running application. @@ -405,33 +405,35 @@ \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 keywords are organized into information, warning, and error categories. \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 - 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 - 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 - \gui Help > \gui {About Plugins} > \gui Utilities > \gui Todo and restart + \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities > + \uicontrol Todo and restart \QC. 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}. \section1 Changing Languages \QC has been localized into several languages. If the system language is one of the supported languages, it is automatically selected. To change the - language, select \gui {Tools > Options > Environment} and select a language - in the \gui Language field. The change takes effect after you restart \QC. + language, select \uicontrol {Tools > Options > Environment} and select a language + in the \uicontrol Language field. The change takes effect after you restart \QC. \section1 Viewing Images @@ -482,15 +484,15 @@ \li For \li Look In \row - \li \gui Tools > \gui Options - \li \gui {Qt Creator} > \gui Preferences + \li \uicontrol Tools > \uicontrol Options + \li \uicontrol {Qt Creator} > \uicontrol Preferences \row - \li \gui Help > \gui {About Plugins} - \li \gui {Qt Creator} > \gui {About Plugins} + \li \uicontrol Help > \uicontrol {About Plugins} + \li \uicontrol {Qt Creator} > \uicontrol {About Plugins} \row \li Keyboard shortcuts - \li \gui {Qt Creator} > \gui Preferences > \gui Environment > - \gui Keyboard + \li \uicontrol {Qt Creator} > \uicontrol Preferences > \uicontrol Environment > + \uicontrol Keyboard \endtable */ diff --git a/doc/src/howto/creator-vcs.qdoc b/doc/src/howto/creator-vcs.qdoc index 3b29a6e4ef..886727a510 100644 --- a/doc/src/howto/creator-vcs.qdoc +++ b/doc/src/howto/creator-vcs.qdoc @@ -73,8 +73,8 @@ \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 be located using the \c{PATH} environment variable or specify the path to - the command line client executables in \gui{Tools} > \gui{Options} > - \gui {Version Control}. + the command line client executables in \uicontrol{Tools} > \uicontrol{Options} > + \uicontrol {Version Control}. 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 @@ -90,26 +90,27 @@ you run Git from a Windows command prompt, it looks for the SSH keys in its installation directory, and therefore, the authorization fails. - You can set the \c HOME environment variable from \QC. Select \gui {Tools > - Options > Version Control > Git}. Select the \gui {Environment Variables} - and the \gui {Set "HOME" environment variable} check boxes. \c HOME is set + You can set the \c HOME environment variable from \QC. Select \uicontrol {Tools > + Options > Version Control > Git}. Select the \uicontrol {Environment Variables} + 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 works as it would with \c {git bash}. \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: \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 submitting. The submit message is passed in as the script's first parameter. If there is an error, the script should output a 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 real name and email address and optionally an alias and a second email address. For example: @@ -120,9 +121,9 @@ \endcode 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 authors as values, for example: @@ -137,17 +138,17 @@ After you specify a file in this field, you can add authors as values of the submit message fields when submitting changes. If - you also specified a \gui{User/alias configuration file}, you can - select authors in the \gui Nicknames dialog. + you also specified a \uicontrol{User/alias configuration file}, you can + 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. For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the 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 - output. The \gui Revert command uses the patch utility to revert + output. The \uicontrol Revert command uses the patch utility to revert partial changes. \endlist @@ -156,24 +157,24 @@ \QC allows you to create repositories for version control systems that 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. - 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. - 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 version control system that you use. Follow the instructions of the wizard to import the project. \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. - The \gui{Version Control} output pane displays the commands that are - executed, a timestamp, and the relevant output. Select \gui {Window > Output + The \uicontrol{Version Control} output pane displays the commands that are + executed, a timestamp, and the relevant output. Select \uicontrol {Window > Output Panes > Version Control} to open the pane. \image qtcreator-vcs-pane.png @@ -203,14 +204,14 @@ 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 - \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 unstage hunks, as well as send them to a code pasting service. \section2 Viewing Versioning History and Change Details - Display the versioning history of a file by selecting \gui{Log} - or \gui{Filelog}. Typically, the log output contains the date, the commit + Display the versioning history of a file by selecting \uicontrol{Log} + or \uicontrol{Filelog}. Typically, the log output contains the date, the commit message, and a change or revision identifier. Click on the identifier to display a description of the change including the diff. Right-clicking on an identifier brings up a context menu that lets you @@ -221,8 +222,8 @@ \section2 Annotating Files - Annotation views are obtained by selecting \gui{Annotate} or \gui{Blame}. - Selecting \gui{Annotate} or \gui{Blame} displays the lines of the file + Annotation views are obtained by selecting \uicontrol{Annotate} or \uicontrol{Blame}. + Selecting \uicontrol{Annotate} or \uicontrol{Blame} displays the lines of the file prepended by the change identifier they originate from. Clicking on the change identifier shows a detailed description of the change. @@ -238,19 +239,19 @@ \section2 Committing Changes 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 message and a checkable list of modified files to be included. \image qtcreator-vcs-commit.png 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 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. \section2 Reverting Changes @@ -260,7 +261,7 @@ 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. \section3 Reverting Changes Using Git @@ -272,21 +273,21 @@ \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 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 index. This returns the current file to the state it was in right 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. This is useful after applying patches for review, for example. You - can choose between a \gui Soft reset that does not touch the index - file nor the working tree at all, a \gui Hard reset that discards - all changes to tracked files in working tree, and a \gui Mixed + can choose between a \uicontrol Soft reset that does not touch the index + file nor the working tree at all, a \uicontrol Hard reset that discards + all changes to tracked files in working tree, and a \uicontrol Mixed reset that resets HEAD and the index (nothing remains staged) without touching the working directory. @@ -294,12 +295,12 @@ \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. \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 between updating the current project and updating all projects. @@ -308,7 +309,7 @@ \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 deleted files for a commit. @@ -317,20 +318,20 @@ 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 \header \li Menu Item \li Description \row - \li \gui Pull + \li \uicontrol Pull \li Turn the branch into a mirror of another branch. \row - \li \gui Push + \li \uicontrol Push \li Update a mirror of the branch. \row - \li \gui Uncommit + \li \uicontrol Uncommit \li Remove the last committed revision. \endtable @@ -338,19 +339,19 @@ 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 - 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 in a checkout. 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 - anything, select \gui {Dry Run}. + To test the outcome of the \uicontrol Uncommit command without actually removing + 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 the commit. @@ -361,30 +362,30 @@ ClearCase client plugin is available on Linux and Windows for accessing a ClearCase server. - The \gui ClearCase submenu contains the following additional items: + The \uicontrol ClearCase submenu contains the following additional items: \table \header \li Menu Item \li Description \row - \li \gui{Check In} + \li \uicontrol{Check In} \li Create a permanent new version of the current file or all files in the versioned object base (VOB). \row - \li \gui{Check In Activity} + \li \uicontrol{Check In Activity} \li Check in checked-out versions in the change set of the current Unified Change Management (UCM) activity. \row - \li \gui{Check Out} + \li \uicontrol{Check Out} \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. \row - \li \gui{Undo Check Out} + \li \uicontrol{Undo Check Out} \li Cancel the checkout for a file and delete the checked-out version. \row - \li \gui{Undo Hijack} + \li \uicontrol{Undo Hijack} \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 without checking it out, you \e hijack the file. @@ -395,8 +396,8 @@ CVS is an open source version control system. In addition to the standard version control system functions, you can - select \gui Tools > \gui CVS > \gui Edit to open a file for editing. - To discard the changes that you made in a file, select \gui Unedit. + select \uicontrol Tools > \uicontrol CVS > \uicontrol Edit to open a file for editing. + To discard the changes that you made in a file, select \uicontrol Unedit. \section2 Using Additional Git Functions @@ -409,36 +410,39 @@ \section3 Working with the Current File 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. - 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 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 - are displayed in the \gui {Clean Repository} dialog. Ignored files are - deselected by default. Select the files to delete and click \gui Delete. + are displayed in the \uicontrol {Clean Repository} dialog. Ignored files are + deselected by default. Select the files to delete and click \uicontrol Delete. \section3 Working with Local Repositories 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. - To apply latest changes to the last commit, select \gui Tools > \gui Git > - \gui {Local Repository} > \gui {Amend Last Commit}. You can also edit the + To apply latest changes to the last commit, select \uicontrol Tools > \uicontrol Git > + \uicontrol {Local Repository} > \uicontrol {Amend Last Commit}. You can also edit the commit message. To amend an earlier comment in a series of related commits, select - \gui Tools > \gui Git > \gui {Local Repository} > - \gui {Fixup Previous Commit}. This operation is done using interactive + \uicontrol Tools > \uicontrol Git > \uicontrol {Local Repository} > + \uicontrol {Fixup Previous Commit}. This operation is done using interactive rebase. In case of conflicts, a merge tool is suggested. - To change a series of commits in the local repository, select \gui Tools > - \gui Git > \gui {Local Repository} > \gui {Interactive Rebase}. You can + To change a series of commits in the local repository, select \uicontrol Tools > + \uicontrol Git > \uicontrol {Local Repository} > \uicontrol {Interactive Rebase}. You can reorder or discard commits, squash them into a single commit, or edit the commit messages. @@ -447,7 +451,7 @@ \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 names to edit them. @@ -460,56 +464,56 @@ \li Menu Item \li Description \row - \li \gui{Refresh} + \li \uicontrol{Refresh} \li Refresh the list of branches. \row - \li \gui{Add} + \li \uicontrol{Add} \li Create new tracking and non-tracking branches. \row - \li \gui{Remove} + \li \uicontrol{Remove} \li Remove a local branch. You cannot delete remote branches. \row - \li \gui Rename + \li \uicontrol Rename \li Rename a local branch. \row - \li \gui{Checkout} + \li \uicontrol{Checkout} \li Check out the selected branch and make it current. You can stash changes you have made to tracked files. \row - \li \gui{Diff} + \li \uicontrol{Diff} \li Show the differences between the selected and the current branch. \row - \li \gui{Log} + \li \uicontrol{Log} \li Show the changes in a branch. \row - \li \gui Merge + \li \uicontrol Merge \li Join the development histories in two branches together. If the commit you are merging can be reached by following the first commit's history, there is no divergent work to merge together. To allow Git to move the branch pointer forward, - select \gui {Fast-Forward}. If you do not want to fast-forward - the branch, select \gui {No Fast-Forward}. + select \uicontrol {Fast-Forward}. If you do not want to fast-forward + the branch, select \uicontrol {No Fast-Forward}. \row - \li \gui Rebase + \li \uicontrol Rebase \li Copy local commits to the updated upstream head. \row - \li \gui {Cherry Pick} + \li \uicontrol {Cherry Pick} \li Cherry pick the top commit from the selected branch. \row - \li \gui Track + \li \uicontrol Track \li Set the current branch to track the selected one. \endtable \section4 Applying Patches 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 > - \gui {Local Repository} > \gui {Apply from Editor}. + To apply a patch file that is open in \QC, select \uicontrol Tools > \uicontrol Git > + \uicontrol {Local Repository} > \uicontrol {Apply from Editor}. To select the patch file to apply from the file system, select - \gui {Apply from File}. + \uicontrol {Apply from File}. \section4 Using Stashes @@ -518,25 +522,25 @@ changes to work on higher priority tasks or to pull in new chages from another repository. - To stash all local changes, select \gui Tools > \gui Git > - \gui {Local Repository} > \gui Stash > \gui Stash. The working copy is reset + To stash all local changes, select \uicontrol Tools > \uicontrol Git > + \uicontrol {Local Repository} > \uicontrol Stash > \uicontrol Stash. The working copy is reset to the state it had after the last commit. 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, - 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 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 - the current working tree state, select \gui {Stash Pop}. + the current working tree state, select \uicontrol {Stash Pop}. \section3 Applying Actions to Commits 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. \image creator-git-commit-actions.png "Select a Git Commit dialog" @@ -544,17 +548,17 @@ \section3 Working with Remote Repositories 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 - files, you are prompted to stash the changes. Select \gui Tools > - \gui Options > \gui {Version Control} > \gui Git and then select the - \gui {Pull with rebase} check box to perform a rebase operation while + files, you are prompted to stash the changes. Select \uicontrol Tools > + \uicontrol Options > \uicontrol {Version Control} > \uicontrol Git and then select the + \uicontrol {Pull with rebase} check box to perform a rebase operation while pulling. \section4 Managing Remote Repositories - To manage remote repositories available in Git, select \gui Tools > \gui Git - > \gui {Remote Repository} > \gui{Manage Remotes}. Double-click the names + To manage remote repositories available in Git, select \uicontrol Tools > \uicontrol Git + > \uicontrol {Remote Repository} > \uicontrol{Manage Remotes}. Double-click the names and URLs of the remote repositories to edit them. The following operations are supported: @@ -564,20 +568,20 @@ \li Menu Item \li Description \row - \li \gui{Refresh} + \li \uicontrol{Refresh} \li Refresh the list of remote repositories. \row - \li \gui{Add} + \li \uicontrol{Add} \li Add a new remote repository. \row - \li \gui{Fetch} + \li \uicontrol{Fetch} \li Fetch all the branches and change information from a remote repository. \row - \li \gui Push + \li \uicontrol Push \li Push committed changes to the remote repository. \row - \li \gui{Remove} + \li \uicontrol{Remove} \li Remove a remote repository. \endtable @@ -585,93 +589,94 @@ \section4 Using Git with Subversion 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 > - \gui {Remote Repository} > \gui Subversion > \gui Fetch. + Subversion repository to a Git repository, select \uicontrol Tools > \uicontrol Git > + \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 If your Git project uses Gerrit for code reviews, you can view your changes 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. \image qtcreator-gerrit-options.png - To push committed changes to Gerrit, select \gui Tools > \gui Git > - \gui {Remote Repository} > \gui {Push to Gerrit}. + To push committed changes to Gerrit, select \uicontrol Tools > \uicontrol Git > + \uicontrol {Remote Repository} > \uicontrol {Push to Gerrit}. To view the same information about each change as in the Gerrit - web interface, select \gui Tools > \gui Git > \gui {Remote Repository} > - \gui Gerrit. + web interface, select \uicontrol Tools > \uicontrol Git > \uicontrol {Remote Repository} > + \uicontrol Gerrit. \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 - \gui {Cherry Pick}. To remove the change after testing it, select \gui Tools > - \gui Git > \gui {Local Repository} > \gui Reset. In the - \gui {Undo Changes to} dialog, select the - state to reset the working directory to, and then select \gui OK. + \uicontrol {Cherry Pick}. To remove the change after testing it, select \uicontrol Tools > + \uicontrol Git > \uicontrol {Local Repository} > \uicontrol Reset. In the + \uicontrol {Undo Changes to} dialog, select the + 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 - To start a graphical interface to Git, select \gui Tools > \gui Git > - \gui {Git Tools} > \gui {Git Gui}. + To start a graphical interface to Git, select \uicontrol Tools > \uicontrol Git > + \uicontrol {Git Tools} > \uicontrol {Git Gui}. \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 - \gui Preferences > \gui {Version Control} > \gui Git, and set the path to - the environment that contains Git Gui in the \gui {Prepend to PATH} field. + \uicontrol Preferences > \uicontrol {Version Control} > \uicontrol Git, and set the path to + 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 > - \gui {Git Tools} > \gui Gitk. You can also start the tool to view commits in + To start the commit viewer for Git, select \uicontrol Tools > \uicontrol Git > + \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. - To specify arguments for running Gitk, select \gui Tools > \gui Options > - \gui {Version Control} > \gui Git. + To specify arguments for running Gitk, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Version Control} > \uicontrol Git. To use some other application for viewing Git history, such as GitX or - QGit viewer, select \gui Tools > \gui Options > \gui {Version Control} > - \gui Git and specify the path to the application executable in the - \gui {Command} field. To start the application, select \gui Tools > \gui Git - > \gui {Git Tools} > \gui {Repository Browser}. + QGit viewer, select \uicontrol Tools > \uicontrol Options > \uicontrol {Version Control} > + \uicontrol Git and specify the path to the application executable in the + \uicontrol {Command} field. To start the application, select \uicontrol Tools > \uicontrol Git + > \uicontrol {Git Tools} > \uicontrol {Repository Browser}. - To resolve merge conflicts, select \gui Tools > \gui Git > \gui {Git Tools} - > \gui {Merge Tool}. + To resolve merge conflicts, select \uicontrol Tools > \uicontrol Git > \uicontrol {Git Tools} + > \uicontrol {Merge Tool}. \section2 Using Additional Mercurial Functionality 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 \header \li Menu Item \li Description \row - \li \gui{Import} + \li \uicontrol{Import} \li Apply changes from a patch file. \row - \li \gui{Incoming} + \li \uicontrol{Incoming} \li Monitor the status of a remote repository by listing the changes that will be pulled. \row - \li \gui{Outgoing} + \li \uicontrol{Outgoing} \li Monitor the status of a remote repository by listing the changes that will be pushed. \row - \li \gui{Pull} + \li \uicontrol{Pull} \li Pull changes from the remote repository. \row - \li \gui{Push} + \li \uicontrol{Push} \li Push changes to the remote repository. \endtable @@ -681,36 +686,36 @@ Perforce Software. 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 - message is displayed in the \gui {Version Control} output pane: - \gui {Perforce: Unable to determine the repository: "p4.exe" + message is displayed in the \uicontrol {Version Control} output pane: + \uicontrol {Perforce: Unable to determine the repository: "p4.exe" 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. 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 - deselect the \gui Load check box for the \gui Perforce plugin in the - \gui {Version Control} group. + get rid of the error message. Choose \uicontrol {Help > About Plugins} and + deselect the \uicontrol Load check box for the \uicontrol Perforce plugin in the + \uicontrol {Version Control} group. - The \gui Perforce submenu contains the following additional items: + The \uicontrol Perforce submenu contains the following additional items: \table \header \li Menu Item \li Description \row - \li \gui{Describe} + \li \uicontrol{Describe} \li View information about changelists and the files in them. \row - \li \gui{Edit File} + \li \uicontrol{Edit File} \li Open a file for editing. \row - \li \gui{Opened} + \li \uicontrol{Opened} \li List files that are open for editing. \row - \li \gui{Pending Changes} + \li \uicontrol{Pending Changes} \li Group files for commit. \endtable @@ -719,7 +724,7 @@ Subversion is an open source version control system. 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. */ diff --git a/doc/src/howto/qtcreator-faq.qdoc b/doc/src/howto/qtcreator-faq.qdoc index e4cfd794d5..521e2feba0 100644 --- a/doc/src/howto/qtcreator-faq.qdoc +++ b/doc/src/howto/qtcreator-faq.qdoc @@ -95,7 +95,7 @@ \li Launch \QC from command line, with \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 @@ -143,7 +143,7 @@ compiler. What should I do?} 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 need or the environment they run in. @@ -154,8 +154,8 @@ \QC has been localized into several languages. If the system language is one of the supported languages, it is automatically selected. - To change the language, select \gui {Tools > Options > Environment} and - select a language in the \gui Language field. The change takes effect after + To change the language, select \uicontrol {Tools > Options > Environment} and + select a language in the \uicontrol Language field. The change takes effect after you restart \QC. \b {Has a reported issue been addressed?} @@ -174,10 +174,10 @@ the Qt Help plugin. The integrated Qt Reference Documentation is available for Qt 4.4 and later. \QC and other Qt deliverables contain 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, - select \gui {Tools > Options > Help > Documentation}. For more + select \uicontrol {Tools > Options > Help > Documentation}. For more information, see \l{Adding External Documentation}. \section1 Debugger Questions @@ -200,28 +200,28 @@ \b {How do I generate a core file in \QC?} 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 current working directory. You can specify another location for the file, including a relative or absolute path, as an argument of the command. - To generate a temporary core file, select \gui {Create Snapshot} in the - context menu in the \gui Snapshot view. The core file is deleted when you + To generate a temporary core file, select \uicontrol {Create Snapshot} in the + context menu in the \uicontrol Snapshot view. The core file is deleted when you stop debugging. \section1 Compiler Questions \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 - in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the + On Linux and OS X, go to \uicontrol Project mode, select your configuration + 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: \c{-j <num>} On Windows, nmake does not support the \c{-j} parameter. Instead, we 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}. - 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. \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 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}. \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 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. For GUI applications, \c qDebug() and related functions use the Windows API 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 external debug output viewer, such as the \l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows} diff --git a/doc/src/ios/creator-ios-dev.qdoc b/doc/src/ios/creator-ios-dev.qdoc index cbba1f7f9c..dbeb658828 100644 --- a/doc/src/ios/creator-ios-dev.qdoc +++ b/doc/src/ios/creator-ios-dev.qdoc @@ -55,9 +55,9 @@ \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. @@ -81,13 +81,13 @@ The next time you connect the device to the Mac computer, \QC detects it automatically. To disable automatic connections to a - device that you do not use for development, select \gui Preferences > - \gui iOS, and deselect the - \gui {Ask about devices not in developer mode} check box. + device that you do not use for development, select \uicontrol Preferences > + \uicontrol iOS, and deselect the + \uicontrol {Ask about devices not in developer mode} check box. \note If \QC does not detect the devices, the iOS plugin might not be - enabled. Select \gui {Qt Creator} > \gui {About Plugins} > - \gui {Device Support} > \gui iOS and restart \QC. + enabled. Select \uicontrol {Qt Creator} > \uicontrol {About Plugins} > + \uicontrol {Device Support} > \uicontrol iOS and restart \QC. \li To specify build settings: @@ -96,14 +96,14 @@ \li Open a project for an application you want to develop for the 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. \image qtcreator-ios-add-kit.png "Build & Run Settings" \endlist - \li Select \gui Run to specify run settings. + \li Select \uicontrol Run to specify run settings. Usually, you can use the default settings. @@ -117,19 +117,19 @@ \note If you cannot deploy applications, because a provisioning profile is missing, try refreshing the list of provisioning profiles in Xcode. Select - \gui Xcode > \gui Preferences > \gui Accounts > \gui {View Details}, and - then select the \gui Refresh button. + \uicontrol Xcode > \uicontrol Preferences > \uicontrol Accounts > \uicontrol {View Details}, and + then select the \uicontrol Refresh button. \section1 Viewing Device Connection Status 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. - To view information about the connected device, select \gui Preferences > - \gui Devices. + To view information about the connected device, select \uicontrol Preferences > + \uicontrol Devices. \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. \section1 Testing on iOS Simulator @@ -141,8 +141,8 @@ simulates a predefined set of hardware devices and software versions. You can change the simulated hardware and software version in the run - settings for the project. Select \gui Projects > \gui Run, and then select - the device to simulate in the \gui {Device type} field. + settings for the project. Select \uicontrol Projects > \uicontrol Run, and then select + the device to simulate in the \uicontrol {Device type} field. \QC uses the Xcode version set as current on the Mac computer. To check the version, enter the following command: diff --git a/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc b/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc index 169eb5656b..8ec07f5435 100644 --- a/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc +++ b/doc/src/linux-mobile/creator-deployment-embedded-linux.qdoc @@ -33,14 +33,14 @@ You can specify settings for deploying applications to generic Linux devices in the project .pro file. You can view the settings in the - \gui {Run Settings}. + \uicontrol {Run Settings}. \image qtcreator-embedded-linux-deployment-overview.png "Deploy to device" - The files to be installed are listed in the \gui {Deployment} step, - the \gui {Files to deploy} field. The \gui {Local File Path} + The files to be installed are listed in the \uicontrol {Deployment} step, + the \uicontrol {Files to deploy} field. The \uicontrol {Local File Path} 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 missing. Edit the qmake \l{Variables#installs} {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" - 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 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. - If you have a lot of data to copy, select \gui Details in the - \gui {Upload Files via SFTP} step, and then select the - \gui {Incremental deployment} check box. \QC takes note of the deployment + If you have a lot of data to copy, select \uicontrol Details in the + \uicontrol {Upload Files via SFTP} step, and then select the + \uicontrol {Incremental deployment} check box. \QC takes note of the 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 from the device manually or flashing a new disk image, or when you use @@ -79,12 +79,12 @@ have \QC deploy all files again. 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. - 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. Errors due to lack of disk space can otherwise be hard to detect. diff --git a/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc index e276915812..8d5ba20543 100644 --- a/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc +++ b/doc/src/linux-mobile/creator-projects-running-generic-linux.qdocinc @@ -7,7 +7,7 @@ \li Specify a connection to the device. For more information, see \l{Connecting Embedded Linux Devices}. - \li Click the \gui Run button. + \li Click the \uicontrol Run button. \endlist @@ -17,9 +17,9 @@ \QC copies the application files to the connected device and runs the application. The application views are 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 \l{Specifying Run Settings for Linux-Based Devices}. diff --git a/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc b/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc index 5eb597f709..34098ad36c 100644 --- a/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc +++ b/doc/src/linux-mobile/creator-projects-settings-run-linux.qdocinc @@ -3,7 +3,7 @@ To run and debug an application on a Linux-based device, you must create connections from the development 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 \l {Connecting Embedded Linux Devices}. @@ -12,10 +12,10 @@ The run settings display the path to the executable file on the development host and on the device. To specify that another application launches your application, for example, enter the - command in the \gui {Alternate executable on device} field and select the - \gui {Use this command instead} check box. + command in the \uicontrol {Alternate executable on device} field and select the + \uicontrol {Use this command instead} check box. \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 - \gui Arguments field. + \uicontrol Arguments field. diff --git a/doc/src/linux-mobile/linuxdev-keys.qdocinc b/doc/src/linux-mobile/linuxdev-keys.qdocinc index 0b5b386c26..f8838b6be1 100644 --- a/doc/src/linux-mobile/linuxdev-keys.qdocinc +++ b/doc/src/linux-mobile/linuxdev-keys.qdocinc @@ -10,17 +10,18 @@ \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" - \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 \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. - \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. \endlist diff --git a/doc/src/linux-mobile/linuxdev-processes.qdocinc b/doc/src/linux-mobile/linuxdev-processes.qdocinc index a0fb08553a..380582a058 100644 --- a/doc/src/linux-mobile/linuxdev-processes.qdocinc +++ b/doc/src/linux-mobile/linuxdev-processes.qdocinc @@ -1,12 +1,13 @@ \section2 Managing Device Processes 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. - 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}. diff --git a/doc/src/linux-mobile/linuxdev.qdoc b/doc/src/linux-mobile/linuxdev.qdoc index 08e9d0f7a6..cbffbefaf6 100644 --- a/doc/src/linux-mobile/linuxdev.qdoc +++ b/doc/src/linux-mobile/linuxdev.qdoc @@ -31,14 +31,14 @@ If you have a tool chain for building applications for embedded Linux devices installed on the development PC, you can add 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. 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}. 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" @@ -53,11 +53,11 @@ \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 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 for building the applications. @@ -66,30 +66,31 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui Devices > \gui Add - > \gui {Generic Linux Device} > \gui {Start Wizard}. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices + > \uicontrol Add > \uicontrol {Generic Linux Device} + > \uicontrol {Start 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. - \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. 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 application as. This value will be available in the variable \c %{CurrentDevice:UserName}. - \li In the \gui {The authentication type} field, select whether - to use \gui Password or \gui Key authentication, and enter + \li In the \uicontrol {The authentication type} field, select whether + to use \uicontrol Password or \uicontrol Key authentication, and enter the user's password or the file that contains the user's private key. 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 @@ -98,10 +99,11 @@ the SSH port number, which is available in the variable \c %{CurrentDevice:SshPort}. - \li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits - > \gui Add to add a kit for building for the device. Select the + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} + > \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 - \gui {Generic Linux Device} for the device type. + \uicontrol {Generic Linux Device} for the device type. \li To specify build settings: @@ -110,12 +112,12 @@ \li Open a project for an application you want to develop for the 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. \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" diff --git a/doc/src/overview/creator-advanced.qdoc b/doc/src/overview/creator-advanced.qdoc index 6c73d81ffc..58a067dff8 100644 --- a/doc/src/overview/creator-advanced.qdoc +++ b/doc/src/overview/creator-advanced.qdoc @@ -86,7 +86,7 @@ \li \l{Showing Task List Files in Issues Pane} 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. \endlist diff --git a/doc/src/overview/creator-configuring.qdoc b/doc/src/overview/creator-configuring.qdoc index 17dfe02964..59aa1e35e6 100644 --- a/doc/src/overview/creator-configuring.qdoc +++ b/doc/src/overview/creator-configuring.qdoc @@ -60,20 +60,20 @@ automatically become available in \QC. If they do not, you must add the kits yourself to tell \QC where everything is. - To add kits, select \gui Tools > \gui Options > \gui {Build & Run} > - \gui Kits > \gui Add. + To add kits, select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Kits > \uicontrol Add. For more information, see \l{Adding Kits}. 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 - version, but it is not listed in \gui Tools > \gui Options > - \gui {Build & Run} > \gui {Qt Versions}, you must add it. + version, but it is not listed in \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol {Qt Versions}, you must add it. For more information, see \l{Adding Qt Versions}. - Also check that your compiler is listed in \gui Tools > \gui Options > - \gui {Build & Run} > \gui {Compilers}. + Also check that your compiler is listed in \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol {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 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}. @@ -92,7 +93,7 @@ You can use \QC with your favorite keyboard shortcuts. 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}. @@ -101,8 +102,9 @@ Themes enable you to customize the appearance of the \QC UI: widgets, colors, and icons. - To switch from the default theme to a dark theme, select \gui Tools > - \gui Options > \gui Environment, and then select \gui Dark in the \gui Theme + To switch from the default theme to a dark theme, select \uicontrol Tools > + \uicontrol Options > \uicontrol Environment, and then select \uicontrol Dark + in the \uicontrol Theme field. 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 files. - To change the color scheme, select \gui Tools > \gui Options > - \gui {Text Editor} > \gui {Fonts & Color}. + To change the color scheme, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Text Editor} > \uicontrol {Fonts & Color}. 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/} {Kate Editor}. You can download highlight definition files for use with \QC. - To download and use highlight definition files, select \gui Tools > - \gui Options > \gui {Text Editor} > \gui {Generic Highlighter}. + To download and use highlight definition files, select \uicontrol Tools > + \uicontrol Options > \uicontrol {Text Editor} > \uicontrol {Generic Highlighter}. For more information, see \l{Generic Highlighting}. @@ -134,8 +136,8 @@ the statement currently under your cursor. You can add, modify, and remove snippets in the snippet editor. - To open the snippet editor, select \gui Tools > \gui Options > - \gui {Text Editor} > \gui Snippets. + To open the snippet editor, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Text Editor} > \uicontrol 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. 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 \l{Using Version Control Systems}. @@ -164,6 +166,6 @@ 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. - To enable and disable plugins, select \gui Help > \gui {About Plugins}. + To enable and disable plugins, select \uicontrol Help > \uicontrol {About Plugins}. */ diff --git a/doc/src/overview/creator-deployment-overview.qdoc b/doc/src/overview/creator-deployment-overview.qdoc index 9d41e878d3..36f9690765 100644 --- a/doc/src/overview/creator-deployment-overview.qdoc +++ b/doc/src/overview/creator-deployment-overview.qdoc @@ -30,7 +30,7 @@ \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 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. diff --git a/doc/src/overview/creator-glossary.qdoc b/doc/src/overview/creator-glossary.qdoc index b7aaba3732..26e8c0fe26 100644 --- a/doc/src/overview/creator-glossary.qdoc +++ b/doc/src/overview/creator-glossary.qdoc @@ -84,7 +84,7 @@ cross-platform development easier. Each kit consists of a set of values that define one environment, such as a device, 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 \li Mode diff --git a/doc/src/overview/creator-help-overview.qdoc b/doc/src/overview/creator-help-overview.qdoc index e1001a0104..499f49d001 100644 --- a/doc/src/overview/creator-help-overview.qdoc +++ b/doc/src/overview/creator-help-overview.qdoc @@ -38,7 +38,7 @@ \QC comes fully integrated with Qt documentation and examples using 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 pages. diff --git a/doc/src/overview/creator-issues.qdoc b/doc/src/overview/creator-issues.qdoc index 6998b35feb..893cdf0c4a 100644 --- a/doc/src/overview/creator-issues.qdoc +++ b/doc/src/overview/creator-issues.qdoc @@ -104,7 +104,7 @@ \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), check your PATH variable. For more information, see \l{Troubleshooting MinGW Compilation Errors}. @@ -117,7 +117,7 @@ \li When debugging executables created by the GNU Compiler version 4.5.0 (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' software by 'Wave \reg Systems' is installed and active (causing diff --git a/doc/src/overview/creator-overview.qdoc b/doc/src/overview/creator-overview.qdoc index fdae1cc685..52245dca1e 100644 --- a/doc/src/overview/creator-overview.qdoc +++ b/doc/src/overview/creator-overview.qdoc @@ -96,7 +96,7 @@ \QC is integrated to several external native debuggers: GNU 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. The memory and CPU power available on devices are limited and diff --git a/doc/src/projects/creator-projects-autotools.qdoc b/doc/src/projects/creator-projects-autotools.qdoc index 89394975fa..e0a9ff59eb 100644 --- a/doc/src/projects/creator-projects-autotools.qdoc +++ b/doc/src/projects/creator-projects-autotools.qdoc @@ -39,26 +39,27 @@ \title Setting Up an Autotools Project The AutotoolsProjectManager is a plugin for autotools support. It is disabled by default. - To enable the plugin, select \gui{Help > About Plugins > Build Systems > AutotoolsProjectManager}. + To enable the plugin, select \uicontrol{Help > About Plugins > Build Systems + > AutotoolsProjectManager}. To use the plugin, restart \QC. To work with your Autotools project in \QC: \list 1 - \li Select \gui{File > Open File or Project}. + \li Select \uicontrol{File > Open File or Project}. \li Select the Makefile.am file from your project. This is the only way you can use the autotools plugin. \li Select the build directory. Only in-source building is currently supported. - \li Select \gui Finish. + \li Select \uicontrol Finish. \QC displays the project tree structure. The root node displays the project name. All project files are listed below it and you can open them from the list. \image qtcreator-autotools-buildrun.png - \li Select \gui Run to build and run the application. The predefined + \li Select \uicontrol Run to build and run the application. The predefined build steps (autogen.sh or autoreconf, configure, and make) are executed. @@ -66,7 +67,7 @@ executable. \li To check and edit autotools build steps, select - \gui{Projects > Build Settings}. + \uicontrol{Projects > Build Settings}. You can add parameters to the predefined autotools build steps. diff --git a/doc/src/projects/creator-projects-build-run-tutorial.qdoc b/doc/src/projects/creator-projects-build-run-tutorial.qdoc index 0babbea672..2e0c99f14a 100644 --- a/doc/src/projects/creator-projects-build-run-tutorial.qdoc +++ b/doc/src/projects/creator-projects-build-run-tutorial.qdoc @@ -39,23 +39,23 @@ \list 1 - \li In the \gui Welcome mode, select \gui Examples (1). + \li In the \uicontrol Welcome mode, select \uicontrol Examples (1). \image qtcreator-gs-build-example-open.png "Selecting an example" \li Select an example in the list of examples. - You can also search for examples (2). Enter the \gui android or - \gui iOS keyword in the search field to list all the examples tested + You can also search for examples (2). Enter the \uicontrol android or + \uicontrol iOS keyword in the search field to list all the examples tested for Android or iOS. - \note The project opens in the \gui Edit mode, and the documentation + \note The project opens in the \uicontrol Edit mode, and the documentation for the example hides these instructions. To return to these - instructions, select \gui {Previous Page} on the toolbar or + instructions, select \uicontrol {Previous Page} on the toolbar or press \key {Alt+Left}. \li To check that the application code can be compiled and linked for a - device, click the \gui {Kit Selector} and select a + device, click the \uicontrol {Kit Selector} and select a \l{glossary-buildandrun-kit}{kit} for the device. @@ -67,10 +67,10 @@ \li Click \inlineimage qtcreator-run.png - (\gui Run) to build and run the application. + (\uicontrol Run) to build and run the application. \li To see the compilation progress, press \key{Alt+4} to open the - \gui {Compile Output} pane. + \uicontrol {Compile Output} pane. If build errors occur, check that a \l{Adding Qt Versions} {Qt version} and \l{Adding Compilers}{compiler} are installed and @@ -79,7 +79,7 @@ \l{Connecting iOS Devices}{iOS device}, check that the development environment has been set up correctly. - The \gui Build progress bar on the toolbar turns green when the + The \uicontrol Build progress bar on the toolbar turns green when the project is successfully built. The application opens on the device. \endlist diff --git a/doc/src/projects/creator-projects-building-running.qdoc b/doc/src/projects/creator-projects-building-running.qdoc index aded8507b4..07a3f4a0c3 100644 --- a/doc/src/projects/creator-projects-building-running.qdoc +++ b/doc/src/projects/creator-projects-building-running.qdoc @@ -49,7 +49,7 @@ \e {Run configurations} start the application in the location where it was copied by the \e{deploy configuration}. By default, - when you select the \gui Run function, \QC builds the project, + when you select the \uicontrol Run function, \QC builds the project, deploys it to the device defined in the kit, and runs it there. However, if you have not made any changes to the project since you last built and deployed it, \QC simply runs it again. diff --git a/doc/src/projects/creator-projects-building.qdoc b/doc/src/projects/creator-projects-building.qdoc index 59ccb91dd8..d1ee1a9514 100644 --- a/doc/src/projects/creator-projects-building.qdoc +++ b/doc/src/projects/creator-projects-building.qdoc @@ -41,22 +41,22 @@ To check that the application code can be compiled and linked for a device, you can build the project. The build errors and warnings are displayed in - the \gui {Issues} output pane. More detailed information is displayed - in the \gui {Compile Output} pane. + the \uicontrol {Issues} output pane. More detailed information is displayed + in the \uicontrol {Compile Output} pane. To build an application: \list 1 - \li Click the \gui {Build and Run Kit Selector} icon (1) or select - \gui Build > \gui {Open Build and Run Kit Selector} to select the + \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select + \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the build and run \l{glossary-buildandrun-kit}{kit}. \image qtcreator-kit-selector.png "Kit selector" - \li Choose \gui {Build > Build Project} or press \key {Ctrl+B}. + \li Choose \uicontrol {Build > Build Project} or press \key {Ctrl+B}. - You can also select the \gui Run button (2) to also deploy and run + You can also select the \uicontrol Run button (2) to also deploy and run the application after building it. \endlist @@ -65,13 +65,13 @@ \l{Specifying Build Settings}. To quickly check the compile output for changes that you made in one file or - subproject, you can use the \gui Build menu commands to build a file or + subproject, you can use the \uicontrol Build menu commands to build a file or subproject. - To remove all build artifacts, select \gui Build > \gui {Clean All} or - \gui {Clean Project}. To clean the build directory and then build the - project, select \gui Build > \gui {Rebuild All} or \gui {Rebuild Project}. + To remove all build artifacts, select \uicontrol Build > \uicontrol {Clean All} or + \uicontrol {Clean Project}. To clean the build directory and then build the + project, select \uicontrol Build > \uicontrol {Rebuild All} or \uicontrol {Rebuild Project}. - To run qmake to generate new Makefiles, select \gui Build > \gui qmake. + To run qmake to generate new Makefiles, select \uicontrol Build > \uicontrol qmake. */ diff --git a/doc/src/projects/creator-projects-builds-customizing.qdoc b/doc/src/projects/creator-projects-builds-customizing.qdoc index ef05e84a45..2b8149ca58 100644 --- a/doc/src/projects/creator-projects-builds-customizing.qdoc +++ b/doc/src/projects/creator-projects-builds-customizing.qdoc @@ -31,10 +31,11 @@ \title Customizing the Build Process To specify the relationship between the release, build, - and deploy configurations, select \gui Tools > \gui Options > \gui {Build & Run}. By - default, the \gui {Always build project before deploying it} and the - \gui {Always deploy project before running it} options are enabled. - Therefore, when you select the \gui Run function, \QC checks for changes in + and deploy configurations, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run}. By + default, the \uicontrol {Always build project before deploying it} and the + \uicontrol {Always deploy project before running it} options are enabled. + Therefore, when you select the \uicontrol Run function, \QC checks for changes in the project files and also builds and deploys the project if necessary. \image qtcreator-project-options-deploy.png "Project General Options" diff --git a/doc/src/projects/creator-projects-cmake.qdoc b/doc/src/projects/creator-projects-cmake.qdoc index 274d497975..a5bbc9e446 100644 --- a/doc/src/projects/creator-projects-cmake.qdoc +++ b/doc/src/projects/creator-projects-cmake.qdoc @@ -41,8 +41,8 @@ \section1 Setting the Path for CMake - You can set the path for the \c CMake executable in \gui{Tools} > - \gui{Options > Build & Run > CMake}. + You can set the path for the \c CMake executable in \uicontrol{Tools} > + \uicontrol{Options > Build & Run > CMake}. \image qtcreator-cmakeexecutable.png @@ -66,7 +66,7 @@ \list 1 - \li Select \gui{File} > \gui{Open File or Project}. + \li Select \uicontrol{File} > \uicontrol{Open File or Project}. \li Select the \c{CMakeLists.txt} file from your \c CMake project. @@ -92,10 +92,10 @@ \QC builds \c CMake projects by running \c make, \c mingw32-make, or \c nmake depending on your platform. The build errors and warnings are - parsed and displayed in the \gui{Issues} output pane. + parsed and displayed in the \uicontrol{Issues} output pane. By default, \QC builds the \b{all} target. You can specify which - targets to build in \gui{Project} mode, under \gui{Build Settings}. + targets to build in \uicontrol{Project} mode, under \uicontrol{Build Settings}. \image qtcreator-cmake-build-settings.png @@ -104,7 +104,7 @@ \section1 Running CMake Projects - \QC automatically adds \gui{Run Configurations} for all targets specified + \QC automatically adds \uicontrol{Run Configurations} for all targets specified in the \c CMake project file. For more information about known issues for the current version, see diff --git a/doc/src/projects/creator-projects-compilers.qdoc b/doc/src/projects/creator-projects-compilers.qdoc index 182e799c64..b9f8ffbc75 100644 --- a/doc/src/projects/creator-projects-compilers.qdoc +++ b/doc/src/projects/creator-projects-compilers.qdoc @@ -68,30 +68,30 @@ For QCC, also specify the path to the BlackBerry NDK or the QNX Software Development Platform (SDP). - You specify the compiler to use for each kit in \gui Tools > - \gui Options > \gui {Build & Run} > \gui Kits. + You specify the compiler to use for each kit in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. To add compilers: \list 1 - \li Select \gui {Tools > Options > Build & Run > Compilers > Add} and + \li Select \uicontrol {Tools > Options > Build & Run > Compilers > Add} and select a compiler in the list. \image qtcreator-toolchains.png - To clone the selected compiler, select \gui {Clone}. + To clone the selected compiler, select \uicontrol {Clone}. - \li In the \gui Name column, double-click the name to change it. + \li In the \uicontrol Name column, double-click the name to change it. - \li In the \gui{Compiler path} field, enter the path to the directory + \li In the \uicontrol{Compiler path} field, enter the path to the directory where the compiler is located. - \li In the \gui {Platform codegen flags} field, check the flags passed + \li In the \uicontrol {Platform codegen flags} field, check the flags passed to the compiler that specify the architecture on the target platform. - \li In the \gui {Platform linker flags} field, check the flags passed to + \li In the \uicontrol {Platform linker flags} field, check the flags passed to the linker that specify the architecture on the target platform. The linker flags are used only when building with Qbs. @@ -102,7 +102,7 @@ \section1 Adding Custom Compilers To add a compiler that is not listed above or a remote compiler, use the - \gui Custom option and specify the paths to the directories where the + \uicontrol Custom option and specify the paths to the directories where the compiler and make tool are located and options for the compiler. \image creator-compilers-custom.png @@ -111,55 +111,55 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > - \gui Compilers > \gui Add > \gui Custom. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Compilers > \uicontrol Add > \uicontrol Custom. - \li In the \gui Name field, enter a name for the compiler. + \li In the \uicontrol Name field, enter a name for the compiler. - \li In the \gui {Compiler path} field, enter the path to the directory + \li In the \uicontrol {Compiler path} field, enter the path to the directory where the compiler is located. - \li In the \gui {Make path} field, enter the path to the directory where + \li In the \uicontrol {Make path} field, enter the path to the directory where the make tool is located. - \li In the \gui ABI field, specify the ABI version. + \li In the \uicontrol ABI field, specify the ABI version. - \li In the \gui {Predefined macros} field, specify the macros that the + \li In the \uicontrol {Predefined macros} field, specify the macros that the compiler enables by default. Specify each macro on a separate line, in the following format: MACRO[=value]. - \li In the \gui {Header paths} field, specify the paths to directories + \li In the \uicontrol {Header paths} field, specify the paths to directories that the compiler checks for headers. Specify each path on a separate line. - \li In the \gui {C++11 flags} field, specify the flags that turn on + \li In the \uicontrol {C++11 flags} field, specify the flags that turn on C++11 support in the compiler. - \li In the \gui {Qt mkspecs} field, specify the path to the directory + \li In the \uicontrol {Qt mkspecs} field, specify the path to the directory where mkspecs are located. Usually, the path is specified relative to the Qt mkspecs directory. - \li In the \gui {Error parser} field, select the error parser to use. - Select \gui Custom, and then select \gui {Customer Parser Settings} + \li In the \uicontrol {Error parser} field, select the error parser to use. + Select \uicontrol Custom, and then select \uicontrol {Customer Parser Settings} to specify settings for a custom parser: \image qtcreator-custom-parser.png \list 1 - \li In the \gui {Error message capture pattern} field, specify + \li In the \uicontrol {Error message capture pattern} field, specify a regular expression to define what is an error. The custom parser matches the compile output line by line against the - regular expression and displays errors in the \gui Issues + regular expression and displays errors in the \uicontrol Issues output pane. Create regular expression groups that contain the file name, line number and error message. - \li In the \gui {Capture Positions} field, map the regular - expression groups to \gui {File name}, \gui {Line number}, - and \gui Message. + \li In the \uicontrol {Capture Positions} field, map the regular + expression groups to \uicontrol {File name}, \uicontrol {Line number}, + and \uicontrol Message. - \li In the \gui {Test} group, you can test how the message that - you enter in the \gui {Error message} field is matched when + \li In the \uicontrol {Test} group, you can test how the message that + you enter in the \uicontrol {Error message} field is matched when using the current settings. \endlist @@ -168,7 +168,7 @@ \section1 Troubleshooting MinGW Compilation Errors - If error messages displayed in the \gui {Compile Output} pane contain + If error messages displayed in the \uicontrol {Compile Output} pane contain paths where slashes are missing (for example, C:QtSDK), check your PATH variable. At the command line, enter the following commands: diff --git a/doc/src/projects/creator-projects-creating.qdoc b/doc/src/projects/creator-projects-creating.qdoc index 926770cdb6..c9aa9851c3 100644 --- a/doc/src/projects/creator-projects-creating.qdoc +++ b/doc/src/projects/creator-projects-creating.qdoc @@ -57,7 +57,7 @@ of information are needed to create each configuration. For more information about qmake, see the \l{qmake Manual}. You can modify the build and run settings for qmake projects in the - \gui Projects mode. + \uicontrol Projects mode. You can use wizards also to create plain C or C++ projects that use Qbs or CMake, but do not use the Qt library. @@ -222,10 +222,10 @@ \endlist - To create a new project, select \gui File > \gui{New File or Project} and + To create a new project, select \uicontrol File > \uicontrol{New File or Project} and select the type of your project. The contents of the wizard dialogs depend on the project type and the \l{glossary-buildandrun-kit}{kits} that you select in the - \gui {Kit Selection} dialog. Follow the instructions of the wizard. + \uicontrol {Kit Selection} dialog. Follow the instructions of the wizard. For examples of creating different types of projects, see \l{Tutorials}. @@ -234,11 +234,11 @@ \l {Creating Qt Quick Projects}. To change the location of the project directory, and to specify settings - for building and running projects, select \gui{Tools} > \gui{Options} > - \gui{Build & Run} > \gui{General}. + for building and running projects, select \uicontrol{Tools} > \uicontrol{Options} > + \uicontrol{Build & Run} > \uicontrol{General}. To specify build and run settings for different target platforms, - select \gui Projects. + select \uicontrol Projects. \section1 Adding Files to Projects @@ -264,10 +264,10 @@ application executable \li QML files, which specify items in Qt Quick projects. - \gui {Qt Quick 1} creates a QML file that imports Qt Quick 1.1 and - \gui {Qt Quick 2} creates a QML file that imports Qt Quick 2.0. - Select \gui {Qt Quick 1} to add files to a Qt Quick 1 application - and \gui {Qt Quick 2} to add files to a Qt Quick 2 application. + \uicontrol {Qt Quick 1} creates a QML file that imports Qt Quick 1.1 and + \uicontrol {Qt Quick 2} creates a QML file that imports Qt Quick 2.0. + Select \uicontrol {Qt Quick 1} to add files to a Qt Quick 1 application + and \uicontrol {Qt Quick 2} to add files to a Qt Quick 2 application. \li JavaScript files that you can use to write the application logic in Qt Quick projects @@ -300,19 +300,19 @@ \section2 Creating C++ Classes - The \gui {C++ Class Wizard} allows you to create a C++ header and source + The \uicontrol {C++ Class Wizard} allows you to create a C++ header and source file for a new class that you can add to a C++ project. Specify the class name, base class, and header and source files for the class. The wizard supports namespaces. To use a namespace, enter a qualified - class name in the \gui {Class name} field. For example: + class name in the \uicontrol {Class name} field. For example: MyNamespace::MySubNamespace::MyClass. \image qtcreator-cpp-class-wizard.png "Enter Class Name dialog" The names of the header and source file are based on the class name. To - change the default suffix of a file, select \gui Tools > \gui Options > - \gui {C++} > \gui {File Naming}. + change the default suffix of a file, select \uicontrol Tools > \uicontrol Options > + \uicontrol {C++} > \uicontrol {File Naming}. You can create your own project and class wizards. For more information, see \l{Adding New Custom Wizards}. @@ -339,13 +339,13 @@ \section2 Displaying Additional File Types in Projects Pane \QC determines whether to display files from the project folder - in the \gui Projects pane depending on the file type (.pro, .pri, .cpp, + in the \uicontrol Projects pane depending on the file type (.pro, .pri, .cpp, .h, .qrc, and so on). To display other types of files, edit the project file. Add filenames as values of the \c {DISTFILES} variable. You can also use wildcards. For example, the following code specifies that text files are displayed - in the \gui Projects pane: + in the \uicontrol Projects pane: \code @@ -353,7 +353,7 @@ \endcode - This also makes the files available in the \gui Locator. + This also makes the files available in the \uicontrol Locator. \section1 Adding Subprojects to Projects @@ -366,26 +366,26 @@ system that you use. When you create a new project, you can add it to another project as a - subproject in the \gui{Project Management} dialog. However, the root project + subproject in the \uicontrol{Project Management} dialog. However, the root project must specify that qmake uses the \c subdirs template to build the project. - To create a root project, select \gui {File > New File or Project > + To create a root project, select \uicontrol {File > New File or Project > Other Project > Subdirs Project > Choose}. - On the \gui Summary page, select \gui {Finish & Add Subproject} to create + On the \uicontrol Summary page, select \uicontrol {Finish & Add Subproject} to create the root project and to add another project, such as a C++ library. The wizard creates a project file (.pro) that defines a \c subdirs template and the subproject that you add as a value of the \l{Variables#subdirs} {SUBDIRS variable}. It also adds all the necessary files for the subproject. - To add more subprojects, right-click the project name in the \gui Projects - pane, and select \gui {New Subproject} in the context menu. + To add more subprojects, right-click the project name in the \uicontrol Projects + pane, and select \uicontrol {New Subproject} in the context menu. - To remove subprojects, right-click the project name in the \gui Projects - pane, and select \gui {Remove Subproject} in the context menu. + To remove subprojects, right-click the project name in the \uicontrol Projects + pane, and select \uicontrol {Remove Subproject} in the context menu. - To specify dependencies, use the \gui{Add Library} wizard. For more + To specify dependencies, use the \uicontrol{Add Library} wizard. For more information, see \l{Adding Libraries to Projects}. \section1 Related Topics diff --git a/doc/src/projects/creator-projects-custom-wizards.qdoc b/doc/src/projects/creator-projects-custom-wizards.qdoc index d9c0a72bef..1e4a43b3c4 100644 --- a/doc/src/projects/creator-projects-custom-wizards.qdoc +++ b/doc/src/projects/creator-projects-custom-wizards.qdoc @@ -35,8 +35,8 @@ and classes. You can copy the wizard templates in the template folders to create your own - project and class wizards. They are displayed in the \gui New dialog that - opens when you choose \gui {File > New File or Project}. + project and class wizards. They are displayed in the \uicontrol New dialog that + opens when you choose \uicontrol {File > New File or Project}. In a project wizard, you can specify the files needed in a project. You can add wizard pages to allow developers to specify settings for the @@ -48,8 +48,8 @@ To see how this works, rename wizard_sample.xml as wizard.xml in the \c {\share\qtcreator\templates\wizards\helloworld} and \c {\share\qtcreator\templates\wizards\listmodel} folders. After - you restart \QC, the \gui {Custom Classes} - and \gui {Custom Projects} categories (1) appear in the \gui New dialog. For + you restart \QC, the \uicontrol {Custom Classes} + and \uicontrol {Custom Projects} categories (1) appear in the \uicontrol New dialog. For each category, an icon (2), a display name (3), and a description (4) are displayed. @@ -108,7 +108,7 @@ \li Modify the wizard_example.xml file. \li The following code determines the type of the wizard and its place - in the \gui New dialog: + in the \uicontrol New dialog: \code @@ -137,16 +137,16 @@ \li \c id is the unique identifier for your wizard. The letter specifies the position of the wizard within the \c category. The HelloWorld wizard appears as the first wizard in the second - category in the \gui New dialog. + category in the \uicontrol New dialog. \li \c category is the category in which to place the wizard in the list. The letter specifies the position of the category in the - list in the \gui New dialog. + list in the \uicontrol New dialog. \endlist \li The following code specifies the icon and text that appear in the - \gui New dialog: + \uicontrol New dialog: \code @@ -162,8 +162,8 @@ \list - \li \c displayCategory appears in the \gui New dialog, under - \gui Projects. + \li \c displayCategory appears in the \uicontrol New dialog, under + \uicontrol Projects. \li \c icon appears next to the \c displayName in the middle panel when \c displayCategory is selected. @@ -204,7 +204,7 @@ \li \c target specifies the new filename for the file. The \c {%ProjectName%} variable is replaced with the string that - users specify in the \gui Name field on the first page of + users specify in the \uicontrol Name field on the first page of the wizard. \li \c openproject indicates that the file is a project file @@ -577,12 +577,12 @@ to \c %Path%. For project wizards, it is \c %Path%/%ProjectName%. \li \c {%CppSourceSuffix%} is replaced by the default source suffix, - which is defined in \QC in \gui {Tools > Options > C++ > + which is defined in \QC in \uicontrol {Tools > Options > C++ > File Naming}. For example, if users enter \b MyClass, the filename becomes myclass.cpp when the project is created. \li \c {%CppHeaderSuffix%} is replaced by the default header suffix, - which is also defined in \gui {File Naming}. + which is also defined in \uicontrol {File Naming}. \li \c {%CurrentDate%} is replaced by the current date in the format \c {YYYY-MM-DD} as specified by ISO 8601. diff --git a/doc/src/projects/creator-projects-debuggers.qdoc b/doc/src/projects/creator-projects-debuggers.qdoc index 514a1c8b43..1382274788 100644 --- a/doc/src/projects/creator-projects-debuggers.qdoc +++ b/doc/src/projects/creator-projects-debuggers.qdoc @@ -37,19 +37,19 @@ The debugger plugin automatically selects a suitable native debugger for each \l{glossary-buildandrun-kit}{kit} from the ones found on your system. - To override this choice, select \gui Tools > \gui Options > - \gui {Build & Run} > \gui Kits. + To override this choice, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol Kits. To add debuggers: \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > - \gui Debuggers > \gui Add. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Debuggers > \uicontrol Add. - \li In the \gui Name field, give a descriptive name for the debugger. + \li In the \uicontrol Name field, give a descriptive name for the debugger. - \li In the \gui Path field, specify the path to the debugger binary: + \li In the \uicontrol Path field, specify the path to the debugger binary: \list @@ -78,7 +78,7 @@ \endlist - \li In the \gui ABIs field, specify the ABI versions to use on embedded + \li In the \uicontrol ABIs field, specify the ABI versions to use on embedded devices. \endlist diff --git a/doc/src/projects/creator-projects-generic.qdoc b/doc/src/projects/creator-projects-generic.qdoc index 51af31f7eb..1cc9701f1f 100644 --- a/doc/src/projects/creator-projects-generic.qdoc +++ b/doc/src/projects/creator-projects-generic.qdoc @@ -32,7 +32,7 @@ Generic project support allows you to use \QC as a code editor. You can change the way your project is built by modifying the \c make command - in the \gui{Projects} mode under \gui{Build Settings}. + in the \uicontrol{Projects} mode under \uicontrol{Build Settings}. When you import a project, \QC creates the following files that allow you to specify which files belong to your project and which include @@ -45,10 +45,10 @@ \list 1 - \li Select \gui File > \gui{New File or Project} > \gui{Import Project} - > \gui{Import Existing Project}. + \li Select \uicontrol File > \uicontrol{New File or Project} > \uicontrol{Import Project} + > \uicontrol{Import Existing Project}. - \li In \gui{Import Existing Project}, enter the project name + \li In \uicontrol{Import Existing Project}, enter the project name and select the location of the project file you want to import. \QC automatically generates the following files in the @@ -96,7 +96,7 @@ is modified externally, you have to restart \QC for the changes to take effect. - To update the \tt{.files} on the \gui Git repository use the following + To update the \tt{.files} on the \uicontrol Git repository use the following script: \code @@ -123,12 +123,12 @@ \QC cannot automatically determine which executable to run. - In the \gui{Projects} mode under \gui{Run Settings}, define the executable + In the \uicontrol{Projects} mode under \uicontrol{Run Settings}, define the executable file to run: \list 1 - \li Click \gui Add and select \gui{Custom Executable}. + \li Click \uicontrol Add and select \uicontrol{Custom Executable}. \li Define the configuration name, the location of the executable, any additional arguments and the working directory. diff --git a/doc/src/projects/creator-projects-libraries.qdoc b/doc/src/projects/creator-projects-libraries.qdoc index 2c63ad5d29..c1a4fa3395 100644 --- a/doc/src/projects/creator-projects-libraries.qdoc +++ b/doc/src/projects/creator-projects-libraries.qdoc @@ -56,8 +56,8 @@ (PRE_TARGETDEPS) in the project file. Depending on the development platform, some options might be detected - automatically. For example, on OS X, the library type (\gui Library or - \gui Framework) is detected automatically and the option is hidden. However, + automatically. For example, on OS X, the library type (\uicontrol Library or + \uicontrol Framework) is detected automatically and the option is hidden. However, if you develop on another platform than OS X and want to build your project for OS X, you must specify the library type. @@ -71,7 +71,7 @@ debug version. For example, if the release version is called example.lib, the debug version is called exampled.lib. You can specify that the letter is added for the debug version and removed for the release version. - If the library name ends in \e d, deselect the \gui {Remove "d" suffix + If the library name ends in \e d, deselect the \uicontrol {Remove "d" suffix for release version} option. \QC supports code completion and syntax highlighting for the added @@ -81,9 +81,9 @@ \list 1 - \li In the \gui Projects pane, right-click the project name to open the + \li In the \uicontrol Projects pane, right-click the project name to open the context menu and select - \gui {Add Library}. + \uicontrol {Add Library}. \li Follow the instructions of the wizard. @@ -99,29 +99,29 @@ \list 1 - \li Choose \gui {File > New File or Project > Libraries > + \li Choose \uicontrol {File > New File or Project > Libraries > C++ Library} to create the library. - The \gui {Introduction and Product Location} dialog opens. + The \uicontrol {Introduction and Product Location} dialog opens. \image qtcreator-add-library-wizard-ex-1.png "Introduction and Product Location dialog" - \li In the \gui Type field, select \gui {Statically Linked Library}. + \li In the \uicontrol Type field, select \uicontrol {Statically Linked Library}. - \li In the \gui Name field, give a name for the library. For example, + \li In the \uicontrol Name field, give a name for the library. For example, \b mylib. \li Follow the instructions of the wizard until you get to the - \gui {Project Management} dialog. In the \gui {Add to project} + \uicontrol {Project Management} dialog. In the \uicontrol {Add to project} list, select a project. For example, \b myapp. - \li In the \gui Projects pane, right-click the project name to open the + \li In the \uicontrol Projects pane, right-click the project name to open the context menu and select - \gui {Add Library > Internal Library > Next}. + \uicontrol {Add Library > Internal Library > Next}. - \li In the \gui Library field, select \b mylib and click \gui Next. + \li In the \uicontrol Library field, select \b mylib and click \uicontrol Next. - \li Click \gui Finish to add the following library declaration to the + \li Click \uicontrol Finish to add the following library declaration to the project file: \code diff --git a/doc/src/projects/creator-projects-opening.qdoc b/doc/src/projects/creator-projects-opening.qdoc index 47ebb6347d..4515e4be65 100644 --- a/doc/src/projects/creator-projects-opening.qdoc +++ b/doc/src/projects/creator-projects-opening.qdoc @@ -35,19 +35,19 @@ to enter the information. If you created the project by using another \QC instance, \QC asks whether you want to use the old settings. The settings are specific to the development environment, and should not be copied from - one environment to another. Therefore, we recommend that you click \gui No - and enter the information again in the \gui {Configure Project} tab. + one environment to another. Therefore, we recommend that you click \uicontrol No + and enter the information again in the \uicontrol {Configure Project} tab. - The \gui {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} + The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} for building and running projects, that are installed on the development PC and - configured in \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits. + configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. Select the kits that you want to build and run the project with. \image qtcreator-open-project-kits.png "Configure Project tab" Even if you do not intend to build the project, the C++ and QML code models need a Qt version and compiler to offer code completion. To specify them, - select the \gui Options link, or select \gui {Tools > Options > Build & Run + select the \uicontrol Options link, or select \uicontrol {Tools > Options > Build & Run > Kits}. If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, @@ -59,7 +59,7 @@ If you have built the project before, \QC can use the existing build configuration to make the exact same build as found in the directory available to \QC. To import a build, specify a directory in the - \gui {Import Build from} section and select \gui {Import}. + \uicontrol {Import Build from} section and select \uicontrol {Import}. You can edit the build configuration later. For more information, see \l{Editing Build Configurations}. @@ -68,11 +68,11 @@ \list 1 - \li Select \gui File > \gui{Open File or Project} and select the project + \li Select \uicontrol File > \uicontrol{Open File or Project} and select the project to open. - \li In the \gui {Configure Project} tab, select kits for building and running your - project, and click \gui {Configure Project}. + \li In the \uicontrol {Configure Project} tab, select kits for building and running your + project, and click \uicontrol {Configure Project}. \endlist @@ -80,7 +80,7 @@ analysis to build up the information that it needs for functions such as navigation and finding usages. A progress bar is displayed during parsing. To show or hide detailed progress information, select - \gui {Toggle Progress Details} (1). + \uicontrol {Toggle Progress Details} (1). \image creator-toggle-progress-bar.png "Toggle Progress Details button" diff --git a/doc/src/projects/creator-projects-qbs.qdoc b/doc/src/projects/creator-projects-qbs.qdoc index a43fd260a6..29379acc30 100644 --- a/doc/src/projects/creator-projects-qbs.qdoc +++ b/doc/src/projects/creator-projects-qbs.qdoc @@ -49,9 +49,9 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > \gui {Plain C - Project (Qbs Build)} or \gui {Plain C++ Project (Qbs Build)} > - \gui Choose, and follow the instructions of the wizard to create a + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol {Plain C + Project (Qbs Build)} or \uicontrol {Plain C++ Project (Qbs Build)} > + \uicontrol Choose, and follow the instructions of the wizard to create a Qbs project. \image creator-qbs-project.png @@ -60,24 +60,24 @@ \c Depends item for a Qt application. For examples, see the \c {examples} directory in the qbs repository. - \li Select \gui Projects to specify \gui {Build Settings} for the + \li Select \uicontrol Projects to specify \uicontrol {Build Settings} for the project. - \li Select \gui {Build Steps} > \gui Details to specify build steps: + \li Select \uicontrol {Build Steps} > \uicontrol Details to specify build steps: \image creator-qbs-build-app.png \list 1 - \li In the \gui {Build variant} field, select \gui Debug to + \li In the \uicontrol {Build variant} field, select \uicontrol Debug to include debug symbols in the build for debugging the - application and \gui Release to create the final + application and \uicontrol Release to create the final installation file. - \li In the \gui {Parallel jobs} field, specify the number of + \li In the \uicontrol {Parallel jobs} field, specify the number of parallel jobs to use for building. - \li Select the \gui {Enable QML debugging} check box to debug + \li Select the \uicontrol {Enable QML debugging} check box to debug Qt Quick application projects. \note Debugging requires opening a socket at a well-known @@ -86,56 +86,56 @@ execute any JavaScript functions. Therefore, you must make sure that the port is properly protected by a firewall. - \li In the \gui Properties field, specify the properties to pass + \li In the \uicontrol Properties field, specify the properties to pass to the project. Use colons (:) to separate keys from values. For more information, see \l{http://qt-project.org/doc/qbs/language-introduction.html} {Modules} in the Qbs Manual. - \li In the \gui Flags field: + \li In the \uicontrol Flags field: \list - \li Select \gui {Dry run} to test building without + \li Select \uicontrol {Dry run} to test building without executing commands or making permanent changes to the build graph. - \li Select \gui {Keep going} to continue building when + \li Select \uicontrol {Keep going} to continue building when errors occur, if possible. \endlist \endlist - The \gui {Equivalent command line} field displays the build command + The \uicontrol {Equivalent command line} field displays the build command that is constructed based on the selected options. - \li Select \gui {Clean Steps} > \gui Details to specify flags for the + \li Select \uicontrol {Clean Steps} > \uicontrol Details to specify flags for the cleaning step. \image creator-qbs-build-clean.png \list - \li Select \gui {Clean all artifacts} to remove all build + \li Select \uicontrol {Clean all artifacts} to remove all build artifacts. - \li Select \gui {Dry run} to test cleaning without executing + \li Select \uicontrol {Dry run} to test cleaning without executing commands or making permanent changes to the build graph. - \li Select \gui {Keep going} to continue cleaning when errors + \li Select \uicontrol {Keep going} to continue cleaning when errors occur, if possible. \endlist - The \gui {Equivalent command line} field displays the clean command + The \uicontrol {Equivalent command line} field displays the clean command that is constructed based on the selected options. - \li Select \gui Build > \gui {Build Project} to build the application. + \li Select \uicontrol Build > \uicontrol {Build Project} to build the application. \li Click the \inlineimage qtcreator-run.png - (\gui Run) button to deploy and run the application. + (\uicontrol Run) button to deploy and run the application. \endlist */ diff --git a/doc/src/projects/creator-projects-qt-versions.qdoc b/doc/src/projects/creator-projects-qt-versions.qdoc index 293191a001..0f1b0f7351 100644 --- a/doc/src/projects/creator-projects-qt-versions.qdoc +++ b/doc/src/projects/creator-projects-qt-versions.qdoc @@ -37,13 +37,13 @@ \QC automatically detects the Qt versions that are registered by your system or by installers. To view detailed information for each Qt - version, select it in the list and select \gui Details in the - \gui {Qt version for} section. To add Qt versions, select - \gui {Tools > Options > Build & Run > Qt Versions}. + version, select it in the list and select \uicontrol Details in the + \uicontrol {Qt version for} section. To add Qt versions, select + \uicontrol {Tools > Options > Build & Run > Qt Versions}. You specify the Qt version to use for each \l{glossary-buildandrun-kit} {kit} for building and running your projects - in \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits. + in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. \section2 Setting Up New Qt Versions @@ -51,7 +51,7 @@ \list 1 - \li Select \gui {Tools > Options > Build & Run > Qt Versions > Add}. + \li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add}. \li Select the qmake executable for the Qt version that you want to add. @@ -60,13 +60,13 @@ \image qtcreator-qt4-qtversions-add.png - \li In the \gui{Version name} field, edit the name that \QC + \li In the \uicontrol{Version name} field, edit the name that \QC suggests for the Qt version. - \li In the \gui{qmake location} field, you can change the qmake + \li In the \uicontrol{qmake location} field, you can change the qmake location. - \li In the \gui Helpers section, select \gui Details to view the + \li In the \uicontrol Helpers section, select \uicontrol Details to view the QML Dumper that has been built for the Qt version. For more information, see \l{Using Debugging Helpers}. @@ -74,7 +74,7 @@ \li If the Qt version is for Blackberry or QNX, enter the path to your installed Blackberry NDK or QNX SDK in the - \gui {Blackberry Native SDK} or \gui{QNX SDK} field respectively. + \uicontrol {Blackberry Native SDK} or \uicontrol{QNX SDK} field respectively. \endlist diff --git a/doc/src/projects/creator-projects-running.qdoc b/doc/src/projects/creator-projects-running.qdoc index 48d7866f64..1fb2c27e7a 100644 --- a/doc/src/projects/creator-projects-running.qdoc +++ b/doc/src/projects/creator-projects-running.qdoc @@ -34,22 +34,22 @@ location from where it can be run on the desktop, on a device emulator or simulator, or on a mobile device that is connected to the development PC. - To run executable files without deploying them first, select \gui Build > - \gui {Run Without Deployment}. To make this the default option, deselect the - \gui Tools > \gui Options > \gui Project > - \gui {Always deploy project before running it} option. + To run executable files without deploying them first, select \uicontrol Build > + \uicontrol {Run Without Deployment}. To make this the default option, deselect the + \uicontrol Tools > \uicontrol Options > \uicontrol Project > + \uicontrol {Always deploy project before running it} option. To run applications: \list 1 - \li Click the \gui {Build and Run Kit Selector} icon (1) or select - \gui Build > \gui {Open Build and Run Kit Selector} to select the + \li Click the \uicontrol {Build and Run Kit Selector} icon (1) or select + \uicontrol Build > \uicontrol {Open Build and Run Kit Selector} to select the build and run \l{glossary-buildandrun-kit}{kit}. \image qtcreator-kit-selector.png "Kit selector" - \li Click the \gui Run button (2). + \li Click the \uicontrol Run button (2). \endlist diff --git a/doc/src/projects/creator-projects-settings-build.qdoc b/doc/src/projects/creator-projects-settings-build.qdoc index dff2078bbf..52d12c7684 100644 --- a/doc/src/projects/creator-projects-settings-build.qdoc +++ b/doc/src/projects/creator-projects-settings-build.qdoc @@ -38,17 +38,17 @@ configuration for testing and the release configuration for creating the final installation file. - You specify build settings in the \gui Projects mode. - To add a new build configuration, click \gui Add and select the type of + You specify build settings in the \uicontrol Projects mode. + To add a new build configuration, click \uicontrol Add and select the type of configuration you would like to add. You can add as many build configurations as you need. - To delete the build configuration currently selected, click \gui Remove. + To delete the build configuration currently selected, click \uicontrol Remove. \section1 Editing Build Configurations Select the build configuration to edit in the - \gui {Edit build configuration} field. + \uicontrol {Edit build configuration} field. \image qtcreator-projectpane.png @@ -56,12 +56,13 @@ directory, as \l{glossary-shadow-build} {shadow builds}. This keeps the files generated for each \l{glossary-buildandrun-kit}{build and run kit} separate. If you only build and run with a single \l{glossary-buildandrun-kit}{kit}, - you can deselect the \gui {Shadow build} + you can deselect the \uicontrol {Shadow build} checkbox. To make in-source builds the default option for all projects, select - \gui Tools > \gui Options > \gui {Build & Run} > \gui General, and enter a - period (.) in the \gui {Default build directory} field. + \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol General, and enter a period (.) in the + \uicontrol {Default build directory} field. \section1 Starting External Processes @@ -70,26 +71,26 @@ commands that are native to the system. It constructs the commands from an executable name and optional command line arguments. - The executable name is specified in the executable fields: \gui qmake, - \gui Make, \gui Command, or \gui Executable. It is either derived from the + The executable name is specified in the executable fields: \uicontrol qmake, + \uicontrol Make, \uicontrol Command, or \uicontrol Executable. It is either derived from the project or specified manually. When you specify executables manually, you can reference environment variables and \QC variables. However, no quoting rules apply. You can specify command-line arguments in the arguments fields: - \gui {Additional arguments}, \gui {Command arguments}, - \gui {Make arguments}, or \gui Arguments. You can create shell command lines + \uicontrol {Additional arguments}, \uicontrol {Command arguments}, + \uicontrol {Make arguments}, or \uicontrol Arguments. You can create shell command lines that can contain redirection and other advanced constructs. However, some more complex use cases, such as piping test data into the application being tested or grouping commands, are not supported because the value of the - \gui Executable field is always placed first when constructing the command. + \uicontrol Executable field is always placed first when constructing the command. \section2 Using Environment Variables You can use any environment variables as values in the fields. For a list - of variable names, click \gui {Build Environment > Details} in the - \gui {Build Settings}. Environment variables are referenced using the native + of variable names, click \uicontrol {Build Environment > Details} in the + \uicontrol {Build Settings}. Environment variables are referenced using the native syntax: $VARNAME or ${VARNAME} on Unix and %VARNAME% on Windows. \section2 Using Qt Creator Variables @@ -98,12 +99,12 @@ directories. The variables take care of quoting their expansions, so you do not need to put them in quotes. Select the \inlineimage qtcreator-variables-button.png - (\gui {Variables}) button in a field to select from a list of variables that + (\uicontrol {Variables}) button in a field to select from a list of variables that are available in a particular context. \section1 Build Steps - The build system of \QC is built on qmake and make. In \gui{Build Steps} you + The build system of \QC is built on qmake and make. In \uicontrol{Build Steps} you can change the settings for qmake and make. \QC runs the make command using the Qt version defined for the current build configuration. @@ -120,19 +121,19 @@ deploy QML files together with the application. \QC new project wizards create projects that the Qt Quick Compiler can compile, because they are set up to use the Qt Resource System. To compile Qt Quick projects, select - the \gui {Enable Qt Quick Compiler} check box. + the \uicontrol {Enable Qt Quick Compiler} check box. \note For more information about the build steps when using Qbs, see \l{Building Applications with Qbs}. \section2 Adding Custom Build Steps - To add custom steps to the build settings, select \gui {Add Build Step > + To add custom steps to the build settings, select \uicontrol {Add Build Step > Custom Process Step}. By default, custom steps are enabled. To disable a custom step, select the \inlineimage qtcreator-disable-steps.png - (\gui Disable) button. + (\uicontrol Disable) button. \image qtcreator-build-steps-custom.png "Custom Process Step" @@ -144,21 +145,21 @@ \image qtcreator-clean-steps.png "Clean steps" - You can define the cleaning steps for your builds in the \gui{Clean Steps}: + You can define the cleaning steps for your builds in the \uicontrol{Clean Steps}: \list \li To add a clean step using make or a custom process, click - \gui{Add Clean Step} and select the type of step you want to add. + \uicontrol{Add Clean Step} and select the type of step you want to add. By default, custom steps are enabled. To disable a custom step, - select the \gui Disable button. + select the \uicontrol Disable button. - \li To remove a clean step, click \gui{Remove Item}. + \li To remove a clean step, click \uicontrol{Remove Item}. \li To change the order of steps, click \inlineimage qtcreator-movestep.png - (\gui {Move Up} and \gui {Move Down}). + (\uicontrol {Move Up} and \uicontrol {Move Down}). \endlist \note For more information about the cleaning steps when using Qbs, see @@ -167,7 +168,7 @@ \section1 Build Environment You can specify the environment you want to use for building in the - \gui {Build Environment} section. By default, the environment in which \QC + \uicontrol {Build Environment} section. By default, the environment in which \QC was started is used and modified to include the Qt version. Depending on the selected Qt version, \QC automatically sets the necessary environment variables. You can edit existing environment @@ -184,8 +185,8 @@ \section2 Batch Editing To modify environment variable values for build or run environments, - select \gui {Batch Edit} in the build or run settings and enter environment - variables in the \gui {Edit Environment} dialog. + select \uicontrol {Batch Edit} in the build or run settings and enter environment + variables in the \uicontrol {Edit Environment} dialog. To remove a variable value from the environment, enter the variable name. For example, \c TEST sets the value of the \c TEST variable empty when @@ -204,7 +205,7 @@ \section2 Clearing the System Environment - To build with a clean system environment, select the \gui {Clear system + To build with a clean system environment, select the \uicontrol {Clear system environment} check box. \QC discards the current environment, and populates a clean system environment with the environment variables that the compilers and tools need. Therefore, the environment is never totally empty, diff --git a/doc/src/projects/creator-projects-settings-code-style.qdoc b/doc/src/projects/creator-projects-settings-code-style.qdoc index 379df033b6..e9bcb48741 100644 --- a/doc/src/projects/creator-projects-settings-code-style.qdoc +++ b/doc/src/projects/creator-projects-settings-code-style.qdoc @@ -32,7 +32,7 @@ \QC uses the \l{Editing MIME Types}{MIME type} of the file to determine which mode and editor to use for opening the file. - \QC opens C++ files in \gui Edit mode in the C++ code editor and + \QC opens C++ files in \uicontrol Edit mode in the C++ code editor and QML files in the Qt Quick editor. You can configure the code style according to your needs. You can specify @@ -42,29 +42,29 @@ settings. To specify global code style settings sets for C++ files, select - \gui {Tools > Options > C++}. + \uicontrol {Tools > Options > C++}. - To specify global code style settings sets for QML files, select \gui {Tools + To specify global code style settings sets for QML files, select \uicontrol {Tools > Options > Qt Quick}. To configure the editor behavior for the current project: \list 1 - \li Select \gui Projects > \gui {Code Style}. + \li Select \uicontrol Projects > \uicontrol {Code Style}. - \li In the \gui Language field, select \gui C++ or \gui {Qt Quick}. + \li In the \uicontrol Language field, select \uicontrol C++ or \uicontrol {Qt Quick}. - \li In the \gui {Current settings} field, select the settings to modify - and click \gui Copy. + \li In the \uicontrol {Current settings} field, select the settings to modify + and click \uicontrol Copy. - \li Give a name to the settings and click \gui OK. + \li Give a name to the settings and click \uicontrol OK. - \li Click \gui Edit to specify code style settings for the project. + \li Click \uicontrol Edit to specify code style settings for the project. \image qtcreator-code-style-settings-edit-cpp.png "Edit Code Style Settings dialog" - \note Only \gui General settings are available for QML files. + \note Only \uicontrol General settings are available for QML files. \image qtcreator-code-style-settings-edit-qtquick.png "Edit Code Style Settings view" diff --git a/doc/src/projects/creator-projects-settings-dependencies.qdoc b/doc/src/projects/creator-projects-settings-dependencies.qdoc index d0f2b410e6..d18f607e86 100644 --- a/doc/src/projects/creator-projects-settings-dependencies.qdoc +++ b/doc/src/projects/creator-projects-settings-dependencies.qdoc @@ -44,9 +44,9 @@ \list 1 - \li In \gui Projects, select a project. + \li In \uicontrol Projects, select a project. - \li Click \gui Dependencies. + \li Click \uicontrol Dependencies. \li Select projects that must be built before the current project is built. diff --git a/doc/src/projects/creator-projects-settings-editor.qdoc b/doc/src/projects/creator-projects-settings-editor.qdoc index fad668df10..9365227037 100644 --- a/doc/src/projects/creator-projects-settings-editor.qdoc +++ b/doc/src/projects/creator-projects-settings-editor.qdoc @@ -32,20 +32,20 @@ \QC uses the \l{Editing MIME Types}{MIME type} of the file to determine which mode and editor to use for opening the file. For example, - \QC opens .txt files in \gui Edit mode in the text editor. + \QC opens .txt files in \uicontrol Edit mode in the text editor. You can configure the text editor according to your needs. You can specify editor behavior either globally for all projects or separately for each - project. To specify global editor behavior, select \gui {Tools > Options + project. To specify global editor behavior, select \uicontrol {Tools > Options > Text Editor > Behavior}. To configure the text editor behavior for the current project: \list 1 - \li Select \gui Projects > \gui Editor. + \li Select \uicontrol Projects > \uicontrol Editor. - \li In the \gui {Editor Settings} field, select \gui {Custom}. + \li In the \uicontrol {Editor Settings} field, select \uicontrol {Custom}. \li Specify text editor settings for the project. @@ -53,7 +53,7 @@ \image qtcreator-editor-settings.png "Editor view" - Click \gui {Restore Global} to revert to the global settings. + Click \uicontrol {Restore Global} to revert to the global settings. For more information about the settings, see: diff --git a/doc/src/projects/creator-projects-settings-overview.qdoc b/doc/src/projects/creator-projects-settings-overview.qdoc index 28c3edfc01..e55a20ce5c 100644 --- a/doc/src/projects/creator-projects-settings-overview.qdoc +++ b/doc/src/projects/creator-projects-settings-overview.qdoc @@ -35,19 +35,19 @@ automatically in \QC. To view and modify the settings for currently open projects, switch to the - \gui Projects mode by pressing \key Ctrl+5. + \uicontrol Projects mode by pressing \key Ctrl+5. You can select build and run \l{glossary-buildandrun-kit}{kits} for the - open projects and use the \gui Build menu commands to build, deploy, and + open projects and use the \uicontrol Build menu commands to build, deploy, and run projects. \section1 Selecting Kits \image qtcreator-project-kits.png - To add kits for the project, select \gui {Add Kit}. The list displays kits - that are configured in \gui Tools > \gui Options > \gui {Build & Run} > - \gui Kits. To add kits to the list, select \gui {Manage Kits}. + To add kits for the project, select \uicontrol {Add Kit}. The list displays kits + that are configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol Kits. To add kits to the list, select \uicontrol {Manage Kits}. For more information about adding kits, see \l{Adding Kits}. Each kit consists of a set of values that define one environment, such as a @@ -55,12 +55,12 @@ \l{Adding Qt Versions}, \l{Adding Compilers}, and \l{Adding Debuggers}. To copy the build and run settings for a kit to another kit, select - \gui {Copy to Kit} in the kit menu. + \uicontrol {Copy to Kit} in the kit menu. To change the kit, while preserving the build and run settings, select - \gui {Change Kit}. + \uicontrol {Change Kit}. - To remove a kit, select \gui {Remove Kit}. + To remove a kit, select \uicontrol {Remove Kit}. \section1 Specifying Settings @@ -79,7 +79,7 @@ \endlist \note If you have not configured the project for building, the - \gui {Build & Run} tab is replaced by the \l{Opening Projects} + \uicontrol {Build & Run} tab is replaced by the \l{Opening Projects} {Configure Projects} tab. \li \l{Specifying Editor Settings}{Editor Settings} @@ -90,7 +90,7 @@ \endlist - Use the \gui Build and \gui Run buttons to switch between the build and + Use the \uicontrol Build and \uicontrol Run buttons to switch between the build and run settings for the active project. If you have multiple projects open in \QC, use the tabs at the top of the diff --git a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc index 62d1b14fd8..956b7c8f59 100644 --- a/doc/src/projects/creator-projects-settings-run-analyze.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-analyze.qdocinc @@ -11,7 +11,7 @@ \list 1 - \li In the \gui {Valgrind Settings} section, select \gui Custom. + \li In the \uicontrol {Valgrind Settings} section, select \uicontrol Custom. \li Specify Valgrind settings for the project. @@ -29,8 +29,8 @@ \endlist - Click \gui {Restore Global} to revert to the global settings. + Click \uicontrol {Restore Global} to revert to the global settings. - To specify global Valgrind settings, select \gui {Tools > Options > + To specify global Valgrind settings, select \uicontrol {Tools > Options > Analyzer}. diff --git a/doc/src/projects/creator-projects-settings-run-debug.qdocinc b/doc/src/projects/creator-projects-settings-run-debug.qdocinc index 6e488a4af5..a871717af8 100644 --- a/doc/src/projects/creator-projects-settings-run-debug.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-debug.qdocinc @@ -2,8 +2,8 @@ \image qtquick-debugging-settings.png "Debugger Settings" - To select the languages to debug, select the \gui {Enable C++} and - \gui {Enable QML} check boxes. The \gui {Debug port} is the port to + To select the languages to debug, select the \uicontrol {Enable C++} and + \uicontrol {Enable QML} check boxes. The \uicontrol {Debug port} is the port to communicate with the debugger. You can use any free port in the registered or dynamic port range. @@ -14,6 +14,6 @@ If you debug more than one application at a time, you might receive an error message stating that the port is already in use. Specify a free port number - in \gui {Debug port} and try again. + in \uicontrol {Debug port} and try again. For more information about debugging, see \l{Debugging}. diff --git a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc index a8f7a37d69..9eb32e1a9e 100644 --- a/doc/src/projects/creator-projects-settings-run-desktop.qdocinc +++ b/doc/src/projects/creator-projects-settings-run-desktop.qdocinc @@ -4,13 +4,13 @@ and the working directory to use. The working directory defaults to the directory of the build result. - For console applications, check the \gui{Run in Terminal} check box. + For console applications, check the \uicontrol{Run in Terminal} check box. If you need to run with special environment variables set up, you also do it in the run configuration settings. \image qtcreator-pprunsettings.png - The \gui {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option + The \uicontrol {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option (only available on OS X) enables you to debug (for example, step into) linked frameworks, such as the Qt framework itself. You do not need this option for debugging your application code. diff --git a/doc/src/projects/creator-projects-settings-run.qdoc b/doc/src/projects/creator-projects-settings-run.qdoc index b2e072dcb8..d62baa1132 100644 --- a/doc/src/projects/creator-projects-settings-run.qdoc +++ b/doc/src/projects/creator-projects-settings-run.qdoc @@ -31,12 +31,12 @@ \title Specifying Run Settings \QC automatically creates run configurations for your project. - To view and modify the settings, select \gui {Projects > Build & Run > Run}. + To view and modify the settings, select \uicontrol {Projects > Build & Run > Run}. The settings to specify depend on the type of the project and on the \l{glossary-buildandrun-kit}{kit} that you build and run the project with. - Click \gui Add to add run settings for a project and \gui Remove to remove + Click \uicontrol Add to add run settings for a project and \uicontrol Remove to remove the current settings. \section1 Specifying Run Settings for qmake Projects @@ -64,31 +64,31 @@ \QC automatically selects the environment used for running the application based on the device type. You can edit the environment or select another - environment in the \gui {Run Environment} section. + environment in the \uicontrol {Run Environment} section. You can edit existing environment variables or add, reset and unset new variables. \image qtcreator-run-environment.png "Run Environment section" - When running on the desktop, the \gui {Build Environment} is used by - default, but you can also use the \gui {System Environment} without the + When running on the desktop, the \uicontrol {Build Environment} is used by + default, but you can also use the \uicontrol {System Environment} without the additions made to the build environment. For more information, see \l {Build Environment}. - To run in a clean system environment, select \gui {Clean Environment}. + To run in a clean system environment, select \uicontrol {Clean Environment}. When running on a mobile device connected to the development host, \QC - fetches information about the \gui {Device Environment} from the device. + fetches information about the \uicontrol {Device Environment} from the device. Usually, it does not make sense to edit the device environment. To modify the environment variable values for the run environment, select - \gui {Batch Edit}. For more information, see \l{Batch Editing}. + \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}. \section1 Specifying a Custom Executable to Run If you use CMake or the generic project type in \QC, or want - to run a custom desktop executable, create a \gui {Custom Executable} + to run a custom desktop executable, create a \uicontrol {Custom Executable} run configuration for your project. For example, when working on a library, you can run a test application that links against the library. diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc index 3b6926d48c..1a523141ba 100644 --- a/doc/src/projects/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -62,16 +62,16 @@ \list 1 - \li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits - > \gui Add. + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} + > \uicontrol Kits > \uicontrol Add. \image qtcreator-kits.png - To clone the selected kit, select \gui Clone. + To clone the selected kit, select \uicontrol Clone. - \li In the \gui Name column, double-click the kit name to change it. + \li In the \uicontrol Name column, double-click the kit name to change it. - \li In the \gui{Device type} field, select the type of the device. + \li In the \uicontrol{Device type} field, select the type of the device. Double-click the icon next to the field to select the image that is displayed in the kit selector for this kit. You can use any @@ -80,29 +80,29 @@ logo as an icon allows you to easily see, which compiler is used to build the project for the selected kit. - \li In the \gui Device field, select a device. + \li In the \uicontrol Device field, select a device. - \li In the \gui Sysroot field, specify the directory where the device + \li In the \uicontrol Sysroot field, specify the directory where the device image is located. If you are not cross-compiling, leave this field empty. - \li In the \gui {Compiler} field, select the compiler required + \li In the \uicontrol {Compiler} field, select the compiler required to build the project. You can add compilers to the list if they are installed on the development PC, but were not detected automatically. For more information, see \l{Adding Compilers}. - \li In the \gui Environment field, select \gui Change to modify + \li In the \uicontrol Environment field, select \uicontrol Change to modify environment variable values for build and run environments in - the \gui {Edit Environment Changes} dialog. For more information + the \uicontrol {Edit Environment Changes} dialog. For more information about how to add and remove variable values, see \l{Batch Editing}. - \li In the \gui Debugger field, select the debugger to debug the project + \li In the \uicontrol Debugger field, select the debugger to debug the project on the target platform. \QC automatically detects available debuggers and displays a suitable debugger in the field. You can add debuggers to the list. For more information, see \l{Adding Debuggers}. - \li In the \gui {Qt version} field, select the Qt version to use for + \li In the \uicontrol {Qt version} field, select the Qt version to use for building the project. You can add Qt versions to the list if they are installed on the development PC, but were not detected automatically. For more information, see \l{Adding Qt Versions}. @@ -110,9 +110,9 @@ \QC checks the directories listed in the \c{PATH} environment variable for the qmake executable. If a qmake executable is found, it is referred to as \b{Qt in PATH} and selected as the Qt - version to use for the \gui Desktop kit that is created by default. + version to use for the \uicontrol Desktop kit that is created by default. - \li In the \gui {Qt mkspec} field, specify the name of the mkspec + \li In the \uicontrol {Qt mkspec} field, specify the name of the mkspec configuration that should be used by qmake. If you leave this field empty, the default mkspec of the selected Qt version is used. diff --git a/doc/src/qnx/creator-deployment-bb10.qdoc b/doc/src/qnx/creator-deployment-bb10.qdoc index ed433c45d2..a99fdd1ca6 100644 --- a/doc/src/qnx/creator-deployment-bb10.qdoc +++ b/doc/src/qnx/creator-deployment-bb10.qdoc @@ -35,36 +35,54 @@ To deploy Qt applications to BlackBerry 10 devices: \list 1 - \li Select \gui File > \gui {New File or Project} > \gui {Application} - to create a \gui {Qt Quick Application}, \gui {Qt Widgets - Application}, or \gui {BlackBerry Cascades Application}. + \li Select \uicontrol File > \uicontrol {New File or Project} + > \uicontrol {Application} to create a + \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 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 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 - \li Select \gui {Use Pre-installed Qt} to use Qt libraries shipped with the device. - \li Select \gui{Bundle Qt in Package} to package and use the Qt version from the active BlackBerry kit. + \li Select \uicontrol {Use Pre-installed Qt} to use Qt libraries + 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. - \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." \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 - 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: \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 a location for the newly created \QC project. \endlist 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}. diff --git a/doc/src/qnx/creator-deployment-qnx.qdoc b/doc/src/qnx/creator-deployment-qnx.qdoc index 0f71cee452..902665241f 100644 --- a/doc/src/qnx/creator-deployment-qnx.qdoc +++ b/doc/src/qnx/creator-deployment-qnx.qdoc @@ -37,10 +37,10 @@ \image qtcreator-qnx-deployment.png "Deploy to device" - The files to be installed are listed in the \gui {Deployment} step, - the \gui {Files to install for subproject} field. The \gui {Local File Path} + The files to be installed are listed in the \uicontrol {Deployment} step, + 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 - \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 missing. Edit the qmake \l{Variables#installs} {INSTALLS variable} in the project .pro file to add the missing files. diff --git a/doc/src/qnx/creator-developing-bb10.qdoc b/doc/src/qnx/creator-developing-bb10.qdoc index 88d0407f08..54274f6ac9 100644 --- a/doc/src/qnx/creator-developing-bb10.qdoc +++ b/doc/src/qnx/creator-developing-bb10.qdoc @@ -42,7 +42,9 @@ \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" @@ -51,41 +53,67 @@ \li Set up API Levels: \list 1 - \li Select \gui Tools > \gui Options > \gui BlackBerry > - \gui {API Levels and Runtimes} to list all registered API Levels automatically + \li Select \uicontrol Tools > \uicontrol Options > \uicontrol BlackBerry > + \uicontrol {API Levels and Runtimes} to list all registered API Levels automatically detected by \QC. \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 Use \gui Add to install a new API Level or to register an existing one. + \li The API Levels printed with a bold font are active. Use + \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. \endlist \li Set up your Signing Keys: \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 Select \gui {Create Certificate} to create a Developer Certificate. - \li To package your application in development mode, select \gui Request to request a debug token or \gui Import to import a valid token. + \li Select \uicontrol {Create Certificate} to create a Developer + 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" - 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 \li Register your device: \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 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. - \li In the \gui {Device password} field, enter the device password. \QC will query information from the device. + \li On the device, select \uicontrol Settings > + \uicontrol {Security and Privacy} > \uicontrol {Development Mode} + 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" - \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" - \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" - \li Select \gui Upload to upload your debug token to the device. - \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. - \li Select \gui Tools > \gui Options > \gui {Build & Run} > \gui Kits to add your device to compatible BlackBerry 10 kits. + \li Select \uicontrol Upload to upload your debug token to the + device. + \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 diff --git a/doc/src/qnx/creator-developing-qnx.qdoc b/doc/src/qnx/creator-developing-qnx.qdoc index 90b64aef2c..c249dfa5e5 100644 --- a/doc/src/qnx/creator-developing-qnx.qdoc +++ b/doc/src/qnx/creator-developing-qnx.qdoc @@ -35,22 +35,22 @@ Development Mode on the device and upload a debug token to it. Enabling Development Mode is done by sliding top-down on the Playbook, - thereby opening the \gui{Preferences}. Now go to \gui{Security > - Development Mode} and set \gui{Use Development Mode} to \gui{ON}. Enter the + thereby opening the \uicontrol{Preferences}. Now go to \uicontrol{Security > + Development Mode} and set \uicontrol{Use Development Mode} to \uicontrol{ON}. Enter the device password when asked to do so. \image qtcreator-qnx-playbook-development-mode.png \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 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 > - USB Connections} to \gui{Connect to Windows} if you are deploying from - Windows, or \gui{Connect to Mac} if you are deploying from Linux or OS X. + To enable access over USB, change \uicontrol{Preferences > Storage & Sharing > + USB Connections} to \uicontrol{Connect to Windows} if you are deploying from + Windows, or \uicontrol{Connect to Mac} if you are deploying from Linux or OS X. \image qtcreator-qnx-playbook-storage-sharing.png @@ -79,43 +79,43 @@ \section1 Adding a BlackBerry Device in \QC - Adding a BlackBerry device is done using a wizard in the \gui{Device - Configurations} options. To launch it, go to \gui Tools > \gui Options > - \gui Devices > \gui Add > \gui {BlackBerry Device} > \gui {Start Wizard}. + Adding a BlackBerry device is done using a wizard in the \uicontrol{Device + Configurations} options. To launch it, go to \uicontrol Tools > \uicontrol Options > + \uicontrol Devices > \uicontrol Add > \uicontrol {BlackBerry Device} > \uicontrol {Start Wizard}. \image qtcreator-qnx-device-configurations-wizard-1.png "Connection details" \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. - \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. - \li In the \gui{Device password} field, enter the password for the device. - \li In the \gui{Device type} field, select whether it is a \gui{Physical - device} or a \gui{Simulator} you are connecting to. - \li In the \gui{Debug token} field, enter the path to the debug token + \li In the \uicontrol{Device password} field, enter the password for the device. + \li In the \uicontrol{Device type} field, select whether it is a \uicontrol{Physical + device} or a \uicontrol{Simulator} you are connecting to. + \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 - connecting to a \gui{Physical device}. - \li Click \gui{Next} to continue. + connecting to a \uicontrol{Physical device}. + \li Click \uicontrol{Next} to continue. \endlist \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 - key, or click \gui{Generate} to create a new key. The generated key will be + For the \uicontrol{SSH Key Setup}, you can either select an existing \b{4096}-bit + 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. - 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. - Once the device is added, you can edit the settings directly in \gui Tools > - \gui Options > \gui Devices. + Once the device is added, you can edit the settings directly in \uicontrol Tools > + \uicontrol Options > \uicontrol Devices. \image qtcreator-qnx-device-configurations.png "Devices" \section1 Adding a QNX Neutrino Device in \QC Adding a QNX Neutrino device is very similar to \l{Connecting Embedded - Linux Devices}, except you need to select \gui{QNX Device} in the - \gui{Device Configuration} wizard. + Linux Devices}, except you need to select \uicontrol{QNX Device} in the + \uicontrol{Device Configuration} wizard. */ diff --git a/doc/src/qnx/creator-key-management-qnx.qdocinc b/doc/src/qnx/creator-key-management-qnx.qdocinc index fc6dced1fa..7aeec07ea6 100644 --- a/doc/src/qnx/creator-key-management-qnx.qdocinc +++ b/doc/src/qnx/creator-key-management-qnx.qdocinc @@ -1,22 +1,28 @@ \section2 Obtaining New Keys To request keys from the BlackBerry Signing Authority, select - \gui Tools > \gui Options > \gui BlackBerry > \gui Keys > \gui Register. - Then select the \gui {BlackBerry website} link, and follow the + \uicontrol Tools > \uicontrol Options > \uicontrol BlackBerry > + \uicontrol Keys > \uicontrol Register. + Then select the \uicontrol {BlackBerry website} link, and follow the instructions. \image qtcreator-blackberry-obtain-keys.png "Requesting new 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" \section2 Creating a New Certificate - To create a new developer certificate, click the \gui {Create Certificate} button to - open the \gui {Create Certificate} dialog. + To create a new developer certificate, click the + \uicontrol {Create Certificate} button to open the + \uicontrol {Create Certificate} dialog. \image qtcreator-blackberry-createcertificatedialog.png "Create Certificate dialog" @@ -35,7 +41,7 @@ \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. \image qtcreator-blackberry-registered-certificate.png "Registered certificate" diff --git a/doc/src/qnx/creator-projects-running-qnx.qdocinc b/doc/src/qnx/creator-projects-running-qnx.qdocinc index 395a8f3610..6b7f122e38 100644 --- a/doc/src/qnx/creator-projects-running-qnx.qdocinc +++ b/doc/src/qnx/creator-projects-running-qnx.qdocinc @@ -12,7 +12,7 @@ \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 @@ -22,14 +22,14 @@ If you are running on a BlackBerry device, \QC generates a BAR package, installs it on the device, and executes the selected application. The 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. It is not possible to insert breakpoints during runtime on Windows. \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 an SSH connection to the device. This is only possible if QNX Momentics is not running, and the SSH key diff --git a/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc b/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc index 180f7f76ee..d5628b3c81 100644 --- a/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc +++ b/doc/src/qnx/creator-projects-settings-run-qnx.qdocinc @@ -2,7 +2,7 @@ To run and debug an application on a QNX or BlackBerry device, you must 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}. \image qtcreator-qnx-run-settings.png "Run settings for QNX devices" diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index fc69705ad6..3d12ca6a36 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -112,7 +112,7 @@ \li \row \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: \l{http://lists.qt-project.org/mailman/listinfo/} diff --git a/doc/src/qtquick/creator-mobile-app-tutorial.qdoc b/doc/src/qtquick/creator-mobile-app-tutorial.qdoc index 6ca1b10603..2608b459b5 100644 --- a/doc/src/qtquick/creator-mobile-app-tutorial.qdoc +++ b/doc/src/qtquick/creator-mobile-app-tutorial.qdoc @@ -61,30 +61,30 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > \gui Application > - \gui {Qt Quick Application} > \gui Choose. + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > + \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. - For example, \c {C:\Qt\examples}, and then click \gui{Next} (or - \gui Continue on OS X). + \li In the \uicontrol {Create in} field, enter the path for the project files. + For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (or + \uicontrol Continue on OS X). - \li In the \gui {Qt Quick component set} field, select - \gui {Qt Quick Controls 1.1}. + \li In the \uicontrol {Qt Quick component set} field, select + \uicontrol {Qt Quick Controls 1.1}. \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 > - \gui Options > \gui {Build & Run} > \gui Kits (on Windows and Linux) - or in \gui {Qt Creator} > \gui Preferences \gui {Build & Run} > - \gui Kits (on OS X). + \note Kits are listed if they have been specified in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux) + or in \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} > + \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. - \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). \endlist @@ -102,12 +102,12 @@ as the QML file) from the examples directory in the Qt installation directory. For example: \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. \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. \li Modify the properties of the ApplicationWindow type to specify the @@ -120,15 +120,15 @@ \skipto /^\}/ \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. - \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. - \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. \li In the code editor, add the following new properties to the image to @@ -245,7 +245,7 @@ } \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. \section1 Adding Resources @@ -255,10 +255,10 @@ \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. - \li Select \gui Add to add Bluebubble.svg. + \li Select \uicontrol Add to add Bluebubble.svg. \endlist @@ -276,7 +276,7 @@ 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 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}. diff --git a/doc/src/qtquick/creator-projects-settings-run-qtquick.qdocinc b/doc/src/qtquick/creator-projects-settings-run-qtquick.qdocinc index 36435e56d2..2647559209 100644 --- a/doc/src/qtquick/creator-projects-settings-run-qtquick.qdocinc +++ b/doc/src/qtquick/creator-projects-settings-run-qtquick.qdocinc @@ -1,13 +1,14 @@ \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 - \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. - \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. \endlist diff --git a/doc/src/qtquick/qtquick-app-tutorial.qdoc b/doc/src/qtquick/qtquick-app-tutorial.qdoc index 754acca694..4322a95896 100644 --- a/doc/src/qtquick/qtquick-app-tutorial.qdoc +++ b/doc/src/qtquick/qtquick-app-tutorial.qdoc @@ -47,31 +47,31 @@ \list 1 - \li Select \gui{File > New File or Project > Application > + \li Select \uicontrol{File > New File or Project > Application > 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. - For example, \c {C:\Qt\examples}, and then click \gui{Next} (on - Windows and Linux) or \gui Continue (on OS X). + \li In the \uicontrol {Create in} field, enter the path for the project files. + For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (on + Windows and Linux) or \uicontrol Continue (on OS X). - \li In the \gui {Qt Quick component set} field, select - \gui {Qt Quick 2.1}. + \li In the \uicontrol {Qt Quick component set} field, select + \uicontrol {Qt Quick 2.1}. \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 > - \gui Options > \gui {Build & Run} > \gui Kits (on Windows and Linux) - or in \gui {Qt Creator} > \gui Preferences \gui {Build & Run} > - \gui Kits (on OS X). + \note Kits are listed if they have been specified in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux) + or in \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} > + \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. - \li Review the project settings, and click \gui{Finish} (on Windows and - Linux) or \gui Done (on OS X) to create the project. + \li Review the project settings, and click \uicontrol{Finish} (on Windows and + Linux) or \uicontrol Done (on OS X) to create the project. \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: \c {C:\Qt\Qt5.3.0\5.3.0\msvc2010\examples\declarative\animation\states}. The 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. \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. - \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" - \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. - \li Select \gui Window to edit its properties. + \li Select \uicontrol Window to edit its properties. \image qmldesigner-tutorial-page.png "Page properties" \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. \li In the code editor, set the window background color to #343434: @@ -126,77 +126,77 @@ \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. \image qmldesigner-tutorial-user-icon.png "Image properties" \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 - \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. - \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, - select \gui Rectangle, + \li In the \uicontrol Design mode, \uicontrol Library view, \uicontrol {QML Types} tab, + select \uicontrol Rectangle, drag and drop it to the canvas, and edit its properties. \image qmldesigner-tutorial-topleftrect.png "Rectangle properties" \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. - \li In the \gui Color field, click the + \li In the \uicontrol Color field, click the \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. - \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 the \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. - \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 page. \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. \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 rectangle and not to the whole page. - \li Edit the \gui {Mouse Area} properties: + \li Edit the \uicontrol {Mouse Area} properties: \list a - \li Click \gui {Layout}, and then click the + \li Click \uicontrol {Layout}, and then click the \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. \li In the code editor, edit the pointer to the clicked expression @@ -222,7 +222,7 @@ \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+V}). \QC renames the new instances of the type topLeftRect1 and topLeftRect2. @@ -231,13 +231,13 @@ \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 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. \li In the code editor, add a pointer to a clicked expression to the @@ -254,12 +254,12 @@ \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. - \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. \li In the code editor, add a pointer to a clicked expression to the @@ -342,15 +342,15 @@ \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 icon, and then click the icon to open the toolbar: \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 diff --git a/doc/src/qtquick/qtquick-buttons.qdoc b/doc/src/qtquick/qtquick-buttons.qdoc index adb54b9ba9..27372f14ef 100644 --- a/doc/src/qtquick/qtquick-buttons.qdoc +++ b/doc/src/qtquick/qtquick-buttons.qdoc @@ -34,52 +34,52 @@ \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). - \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. - \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. - \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 - \li In the \gui Size field, set the width (\gui W) and height - (\gui H) of the button. + \li In the \uicontrol Size field, set the width (\uicontrol W) and height + (\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. \endlist - \li Drag and drop a \gui {Text} item on top of the \gui Rectangle. This - creates a nested item where \gui Rectangle is the parent item - of \gui Text. Items are positioned relative to their parents. + \li Drag and drop a \uicontrol {Text} item on top of the \uicontrol Rectangle. This + creates a nested item where \uicontrol Rectangle is the parent item + 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. \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 - \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. - \li Click \gui {Layout}, and then click the + \li Click \uicontrol {Layout}, and then click the \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. \endlist @@ -130,12 +130,12 @@ \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). \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: \qml @@ -144,7 +144,7 @@ } \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: \qml @@ -161,83 +161,83 @@ 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. - \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 - settings for it in the \gui Properties pane: + \li In the \uicontrol Navigator, select \uicontrol border_image1 to specify + settings for it in the \uicontrol Properties pane: \list a - \li Select \gui {Set Binding} in the menu next to the - \gui Visibility check box. + \li Select \uicontrol {Set Binding} in the menu next to the + \uicontrol Visibility check box. \li Enter the following expression to specify that the image is visible when the mouse is not pressed down: \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. - \li Click \gui {Layout}, and then click the + \li Click \uicontrol {Layout}, and then click the \inlineimage qmldesigner-anchor-fill-screen.png - (\gui {Fill to Parent}) button to anchor the border image to the - \gui Item. + (\uicontrol {Fill to Parent}) button to anchor the border image to the + \uicontrol Item. \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 - \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: \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. - \li Click \gui {Layout}, and then click the - \gui {Fill to Parent} - button to anchor the border image to the \gui Item. + \li Click \uicontrol {Layout}, and then click the + \uicontrol {Fill to Parent} + button to anchor the border image to the \uicontrol Item. \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: \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. - \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 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. - \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 earlier. - \li Click \gui {Layout}, and then click the + \li Click \uicontrol {Layout}, and then click the \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 the parent. - \li Click \gui Advanced to specify scaling for the text in the - \gui Scale field. + \li Click \uicontrol Advanced to specify scaling for the text in the + \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 }}. \note You can enter long and complicated expressions also in the diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc index 6179e3df1c..9ec2582743 100644 --- a/doc/src/qtquick/qtquick-components.qdoc +++ b/doc/src/qtquick/qtquick-components.qdoc @@ -87,20 +87,20 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > - \gui {Files and Classes} > \gui Qt > \gui {QML File (Qt Quick 1)} or - \gui {QML File (Qt Quick 2)} > \gui Choose to create a new .qml + \li Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol {Files and Classes} > \uicontrol Qt > \uicontrol {QML File (Qt Quick 1)} or + \uicontrol {QML File (Qt Quick 2)} > \uicontrol Choose to create a new .qml file. - \note Components are listed in the \gui {QML Components} section of - the \gui Library only if the filename begins with a capital + \note Components are listed in the \uicontrol {QML Components} section of + the \uicontrol Library only if the filename begins with a capital 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. @@ -121,7 +121,7 @@ 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, - 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 top level when you are done editing the component. diff --git a/doc/src/qtquick/qtquick-connection-editor.qdoc b/doc/src/qtquick/qtquick-connection-editor.qdoc index b3ac218b39..822acd4b50 100644 --- a/doc/src/qtquick/qtquick-connection-editor.qdoc +++ b/doc/src/qtquick/qtquick-connection-editor.qdoc @@ -35,7 +35,7 @@ \title Adding Connections - You can use the \gui {Connections} view (commercial only) to: + You can use the \uicontrol {Connections} view (commercial only) to: \list @@ -57,14 +57,14 @@ \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. - \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. \endlist @@ -81,15 +81,15 @@ \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 @@ -104,18 +104,18 @@ \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. - \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. - \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. - \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. \endlist diff --git a/doc/src/qtquick/qtquick-creating.qdoc b/doc/src/qtquick/qtquick-creating.qdoc index a48d403da6..159e49e8a6 100644 --- a/doc/src/qtquick/qtquick-creating.qdoc +++ b/doc/src/qtquick/qtquick-creating.qdoc @@ -38,24 +38,24 @@ \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 QDeclarativeView or QQuickView. You can build the application and deploy it to 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 projects in a \l{Previewing QML Files}{preview tool} and you need not build them. You do not need to have the development environment installed on your 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 can be loaded dynamically into Qt Quick applications. Select - \gui {Qt Quick 1 Extension Plugin} to create extensions for - Qt Quick 1 applications and \gui {Qt Quick 2 Extension Plugin} to + \uicontrol {Qt Quick 1 Extension Plugin} to create extensions for + Qt Quick 1 applications and \uicontrol {Qt Quick 2 Extension Plugin} to create extensions for Qt Quick 2 applications. \endlist @@ -64,10 +64,10 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > \gui Application > - \gui {Qt Quick UI} > \gui Choose. + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > + \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 basic QML types to create user interfaces, whereas the Qt Quick Controls provide a set of ready-made controls that you can customize @@ -75,10 +75,10 @@ \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. - \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 4.7.3, you must change the import statement to import Qt Quick 1.0. @@ -103,8 +103,8 @@ whole application UI. \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 - \gui {Qt Quick 2.4}, or later. The forms can contain a subset of the + if you select \uicontrol {Qt Quick Controls 1.3}, or later, or + \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 recommended that you use \QMLD to edit the UI forms. For more information, see \l{Qt Quick UI Forms}. @@ -118,21 +118,21 @@ \list 1 - \li Select \gui File > \gui {New File or Project} > \gui Application > - \gui {Qt Quick Application} > \gui Choose. + \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > + \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 \l{Creating Qt Quick UI Projects}. \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 > - \gui Options > \gui {Build & Run} > \gui Kits. + \note Kits are listed if they have been specified in \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. - \li Review the project settings, and click \gui{Finish} (on Windows and - Linux) or \gui Done (on OS X) to create the project. + \li Review the project settings, and click \uicontrol{Finish} (on Windows and + Linux) or \uicontrol Done (on OS X) to create the project. \endlist diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc index ef8a0edf7f..e05beee83c 100644 --- a/doc/src/qtquick/qtquick-designer.qdoc +++ b/doc/src/qtquick/qtquick-designer.qdoc @@ -31,7 +31,7 @@ \title Using Qt Quick Designer 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. \image qmldesigner-visual-editor.png "Visual editor" @@ -47,35 +47,35 @@ \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. - \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 components, Qt Quick components or Qt Quick Controls that you 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 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}. - \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}. - \li \gui {Open Documents} sidebar view shows currently open files. + \li \uicontrol {Open Documents} sidebar view shows currently open files. \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. - \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. - \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 the UI controls, their properties and behavior and the available actions. @@ -84,14 +84,14 @@ \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. Items (1) are listed in a tree structure, below their parent (2). \image qmldesigner-navigator.png "Navigator" - You can select items in the \gui Navigator to edit their properties - in the \gui Properties pane. Items can access the properties of their + You can select items in the \uicontrol Navigator to edit their properties + in the \uicontrol Properties pane. Items can access the properties of their parent item. To select items on the canvas, right-click an item, and select another type in the context menu. @@ -109,16 +109,16 @@ Click the \inlineimage qmldesigner-show-hide-icon.png 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 - check box or the \gui Opacity field in the \gui Properties pane. If you set - \gui Opacity to 0, items are hidden, but you can still apply animation + visibility of an item in the application, use the \uicontrol Visibility + check box or the \uicontrol Opacity field in the \uicontrol Properties pane. If you set + \uicontrol Opacity to 0, items are hidden, but you can still apply animation to them. 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. - To view lists of files or projects, instead, select \gui {File System}, - \gui {Open Documents}, or \gui Projects in the menu. + To view lists of files or projects, instead, select \uicontrol {File System}, + \uicontrol {Open Documents}, or \uicontrol Projects in the menu. To view several types of content at a time, split the sidebar by clicking \inlineimage qtcreator-splitbar.png . @@ -133,9 +133,9 @@ up. 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 - \c z property, select \gui {Reset z Property}. + \c z property, select \uicontrol {Reset z Property}. \section2 Switching Parent Items @@ -148,7 +148,7 @@ 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. - 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 buttons (1) to move the item in the tree. @@ -156,10 +156,10 @@ \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. - \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. 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 interfaces using Qt Quick 2.1. The components and controls are based on 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 - \gui Imports + \uicontrol Imports \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). \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 displays properties that are common to all QML types, such as position, size, and visibility. The bottom part of the pane displays properties that are specific to each 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 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 - \gui {Edit > Reset Position} or \gui {Reset Size} in the context menu. To - set the visibility of the item, select \gui {Edit > Visibility}. + \uicontrol {Edit > Reset Position} or \uicontrol {Reset Size} in the context menu. To + set the visibility of the item, select \uicontrol {Edit > Visibility}. For more information on the properties available for an item, press \key {F1}. @@ -212,12 +212,12 @@ 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 following images illustrate this. In the base state, the \gui Size (1) - and \gui Colors (2) values are explicitly set and highlighted. + The following images illustrate this. In the base state, the \uicontrol Size (1) + and \uicontrol Colors (2) values are explicitly set and highlighted. \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" @@ -253,7 +253,7 @@ \section2 Marking Text Items for Translation 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" @@ -350,7 +350,7 @@ \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 transformations to an item. Each transformation is applied in order, one at a time. @@ -403,7 +403,7 @@ \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. \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 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. For more information on using states, see \l{Creating Screens}. @@ -438,13 +438,13 @@ Click the \inlineimage qmldesigner-snap-to-anchors-button.png button to anchor the item to the items that you snap to. - Choose \gui {Tools > Options > Qt Quick > Qt Quick Designer} to specify - settings for snapping. In the \gui {Parent item padding} field, specify the + Choose \uicontrol {Tools > Options > Qt Quick > Qt Quick Designer} to specify + 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 - \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. - 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. \image qmldesigner-snap-margins.png "Snapping lines on canvas" @@ -476,18 +476,18 @@ bindings. To experiment with different component sizes, enter values in the - \gui Height and \gui 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 + \uicontrol Height and \uicontrol Width fields (1) on the canvas toolbar. The changes are + 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 - 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" \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 - 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 @@ -499,6 +499,6 @@ To refresh the image on the canvas, press \key R or select \inlineimage qmldesigner-reset-view.png - (\gui {Reset View}). + (\uicontrol {Reset View}). */ diff --git a/doc/src/qtquick/qtquick-exporting-qml.qdoc b/doc/src/qtquick/qtquick-exporting-qml.qdoc index 887150608d..aa0670b5b2 100644 --- a/doc/src/qtquick/qtquick-exporting-qml.qdoc +++ b/doc/src/qtquick/qtquick-exporting-qml.qdoc @@ -87,7 +87,7 @@ item, use top-level layer groups. \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 exporting them, use descriptive names for them. @@ -122,34 +122,34 @@ information about the script. \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 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. - \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. - \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. - \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. - \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. - \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. - \li Click \gui Export. + \li Click \uicontrol Export. \endlist 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. @@ -186,18 +186,18 @@ 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. - \li In the \gui {Export Layers to a QML Document} dialog, enter a name - and location for the QML file, and click \gui Export. + \li In the \uicontrol {Export Layers to a QML Document} dialog, enter a name + and location for the QML file, and click \uicontrol Export. \endlist 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. diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc index 99ee6b328d..792e3dad29 100644 --- a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc +++ b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc @@ -96,15 +96,15 @@ the box. To use an emulation layer that is built with the Qt - configured in the build and run kit for the project, select \gui Tools > - \gui Options > \gui {Qt Quick} > \gui {Qt Quick Designer} > - \gui {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. + configured in the build and run kit for the project, select \uicontrol Tools > + \uicontrol Options > \uicontrol {Qt Quick} > \uicontrol {Qt Quick Designer} > + \uicontrol {Use QML emulation layer which is built by the selected Qt} radio button. + \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 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 - by an application or edited in the \gui Design mode. + by an application or edited in the \uicontrol Design mode. */ diff --git a/doc/src/qtquick/qtquick-pathview-editor.qdoc b/doc/src/qtquick/qtquick-pathview-editor.qdoc index ed96c7dc06..9c73f90032 100644 --- a/doc/src/qtquick/qtquick-pathview-editor.qdoc +++ b/doc/src/qtquick/qtquick-pathview-editor.qdoc @@ -48,17 +48,17 @@ control points to construct the curve. 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. 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 - 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 \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 initiates mouse dragging and what is the rate at which a flick will decelerate. diff --git a/doc/src/qtquick/qtquick-screens.qdoc b/doc/src/qtquick/qtquick-screens.qdoc index 293abb1e4b..1ca1ee9a29 100644 --- a/doc/src/qtquick/qtquick-screens.qdoc +++ b/doc/src/qtquick/qtquick-screens.qdoc @@ -35,8 +35,8 @@ screens. Typically, the main qml file in a Qt Quick project specifies the main window of an application. - The QML files in the project folder are displayed in \gui {QML Components} - in the \gui Library. + The QML files in the project folder are displayed in \uicontrol {QML Components} + in the \uicontrol Library. 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. @@ -48,10 +48,10 @@ \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 - properties in the \gui Properties pane. + \li Select components in the \uicontrol Navigator to edit their + properties in the \uicontrol Properties pane. 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 delegate component that creates an instance for each item in the model are 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 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 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 - context menu, and select \gui {Set Binding}. + context menu, and select \uicontrol {Set Binding}. \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 \l{Integrating QML and JavaScript}. @@ -136,7 +136,7 @@ invisible \e anchor lines: top, bottom, left, right, fill, horizontal 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 top/bottom, left/right, and horizontal/vertical anchors to anchor items in 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 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. 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 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. \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 Rectangle { @@ -207,7 +207,7 @@ \endlist 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. \section2 Using Layouts @@ -222,7 +222,7 @@ \list \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. @@ -233,14 +233,14 @@ \endlist - To lay out several items in a \gui {Column Layout}, \gui {Row Layout}, or - \gui {Grid Layout}, select the items on the canvas, and then select - \gui Layout in the context menu. + To lay out several items in a \uicontrol {Column Layout}, \uicontrol {Row Layout}, or + \uicontrol {Grid Layout}, select the items on the canvas, and then select + \uicontrol Layout in the context menu. 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 - \gui Layout > \gui {Fill Width} in the context menu. To make the item as - high as possible, select \gui {Fill Height}. + \uicontrol Layout > \uicontrol {Fill Width} in the context menu. To make the item as + high as possible, select \uicontrol {Fill Height}. \section2 Using Split Views @@ -257,7 +257,7 @@ controls, their properties and behavior and the available actions. For 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. \image qmldesigner-states.png "States pane" @@ -297,11 +297,11 @@ \inlineimage qmldesigner-show-hide-icon.png 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. - \li In the \gui Properties pane (2), deselect the \gui Visibility check box - or set \gui Opacity to 0 for each item that is not needed in this + \li In the \uicontrol Properties pane (2), deselect the \uicontrol Visibility check box + 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 items inherit it and are also hidden. @@ -394,7 +394,7 @@ Not visible in the item library in 3.2. \li StatusBar contains status information in your application. It 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 \li TextArea displays multiple lines of editable formatted text. @@ -406,11 +406,11 @@ \li ToolBar provides styling for ToolButton as well as other controls that it can contain. However, it does not provide a layout of its own, but requires you to position its contents, for instance by - creating a \gui {Row Layout}. + creating a \uicontrol {Row Layout}. \endomit \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 diff --git a/doc/src/qtquick/qtquick-toolbars.qdoc b/doc/src/qtquick/qtquick-toolbars.qdoc index 74cb9eab6c..e15a13bfde 100644 --- a/doc/src/qtquick/qtquick-toolbars.qdoc +++ b/doc/src/qtquick/qtquick-toolbars.qdoc @@ -36,13 +36,13 @@ . Select the icon to open the toolbar. 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}. Drag the toolbar to pin it to another location. Select \inlineimage qml-toolbar-pin.png 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}. \section1 Previewing Images @@ -73,7 +73,7 @@ \image qml-toolbar-text.png "Qt Quick Toolbar for text" 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 diff --git a/doc/src/qtquick/qtquick-ui-forms.qdoc b/doc/src/qtquick/qtquick-ui-forms.qdoc index 02b1e5660a..f016d219d1 100644 --- a/doc/src/qtquick/qtquick-ui-forms.qdoc +++ b/doc/src/qtquick/qtquick-ui-forms.qdoc @@ -33,7 +33,7 @@ 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 - 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 messages. @@ -64,7 +64,7 @@ \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: \code @@ -85,7 +85,7 @@ The property alias exports the button to the QML code that uses the form. You can use the \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): \image qmldesigner-export-item.png diff --git a/doc/src/widgets/qtdesigner-app-tutorial.qdoc b/doc/src/widgets/qtdesigner-app-tutorial.qdoc index 99f05ddd9f..201daa2f1f 100644 --- a/doc/src/widgets/qtdesigner-app-tutorial.qdoc +++ b/doc/src/widgets/qtdesigner-app-tutorial.qdoc @@ -41,59 +41,59 @@ \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}. \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" - \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. - For example, \c {C:\Qt\examples}, and then click \gui{Next} (on - Windows and Linux) or \gui Continue (on OS X). + \li In the \uicontrol {Create in} field, enter the path for the project files. + For example, \c {C:\Qt\examples}, and then click \uicontrol{Next} (on + 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" \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 > - \gui {Build & Run} > \gui Kits (on Windows and Linux) or in - \gui {Qt Creator} > \gui Preferences \gui {Build & Run} > \gui Kits + \note If only one kit is specified in \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux) or in + \uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} > \uicontrol Kits (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" - \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. - \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. - \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. - \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" - \li Review the project settings, and click \gui{Finish} (on Windows and - Linux) or \gui Done (on OS X) to create the project. + \li Review the project settings, and click \uicontrol{Finish} (on Windows and + Linux) or \uicontrol Done (on OS X) to create the project. \endlist - \note The project opens in the \gui Edit mode, and these instructions are - hidden. To return to these instructions, open the \gui Help mode. + \note The project opens in the \uicontrol Edit mode, and these instructions are + hidden. To return to these instructions, open the \uicontrol Help mode. The TextFinder project now contains the following files: @@ -123,56 +123,56 @@ \list 1 - \li In the \gui{Editor} mode, double-click the textfinder.ui file in the - \gui{Projects} view to launch the integrated \QD. + \li In the \uicontrol{Editor} mode, double-click the textfinder.ui file in the + \uicontrol{Projects} view to launch the integrated \QD. \li Drag and drop the following widgets to the form: \list - \li \gui{Label} (QLabel) - \li \gui{Line Edit} (QLineEdit) - \li \gui{Push Button} (QPushButton) + \li \uicontrol{Label} (QLabel) + \li \uicontrol{Line Edit} (QLineEdit) + \li \uicontrol{Push Button} (QPushButton) \endlist \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 - \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. \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}. - \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}. - \li In the \gui Properties pane, change the \gui objectName to + \li In the \uicontrol Properties pane, change the \uicontrol objectName to \b findButton. \image qtcreator-textfinder-objectname.png "Changing object names" \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 layout (QHBoxLayout). \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 - \gui{Ctrl+L}) to apply a vertical layout (QVBoxLayout). + \li Select the screen area and click \uicontrol{Lay out Vertically} (or press + \uicontrol{Ctrl+L}) to apply a vertical layout (QVBoxLayout). \image qtcreator-textfinder-ui.png "Text Finder UI" Applying the horizontal and vertical layouts ensures that the 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 particular event occurs and a slot is a function that is called in response to a particular signal. Qt widgets have predefined signals @@ -181,10 +181,10 @@ \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 - \gui OK. + \li Select \uicontrol {Go to Slot > clicked()}, and then select + \uicontrol OK. A private slot, \c{on_findButton_clicked()}, is added to the header file, textfinder.h and a private function, @@ -193,7 +193,7 @@ \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 @@ -209,7 +209,7 @@ \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. \li Add a private function to the \c{private} section, after the @@ -227,7 +227,7 @@ \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. \li Add code to load a text file using QFile, read it with QTextStream, @@ -275,35 +275,35 @@ \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}. \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" - \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}, - and click \gui Next or \gui Continue. + \li In the \uicontrol{Path} field, enter \c{C:\Qt\examples\TextFinder}, + 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" - \li In the \gui{Add to project} field, select \b{TextFinder.pro} - and click \gui{Finish} or \gui Done to open the file in the code + \li In the \uicontrol{Add to project} field, select \b{TextFinder.pro} + and click \uicontrol{Finish} or \uicontrol Done to open the file in the code 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" diff --git a/doc/src/widgets/qtdesigner-overview.qdoc b/doc/src/widgets/qtdesigner-overview.qdoc index ce7dfeb765..8f673e47ff 100644 --- a/doc/src/widgets/qtdesigner-overview.qdoc +++ b/doc/src/widgets/qtdesigner-overview.qdoc @@ -30,7 +30,7 @@ \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. \image qtcreator-formedit.png @@ -42,22 +42,22 @@ \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. 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 - select \gui {Go to Slot}. Select a signal in the list to go to an existing + \uicontrol Design mode, right-click a widget to open a context menu, and then + 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. \section1 Managing Image Resources 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 - 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 - \gui {Resource Browser}. + \uicontrol {Resource Browser}. \section1 Specifying Settings for Qt Designer @@ -67,23 +67,23 @@ \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}. \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}. \endlist - To preview the settings, select \gui Tools > \gui{Form Editor} > - \gui Preview, or press \key Alt+Shift+R. + To preview the settings, select \uicontrol Tools > \uicontrol{Form Editor} > + \uicontrol Preview, or press \key Alt+Shift+R. \section1 Previewing Forms Using Device Skins @@ -95,15 +95,15 @@ \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. \endlist diff --git a/doc/src/widgets/qtdesigner-plugins.qdoc b/doc/src/widgets/qtdesigner-plugins.qdoc index cc02bbc65c..abe839a24f 100644 --- a/doc/src/widgets/qtdesigner-plugins.qdoc +++ b/doc/src/widgets/qtdesigner-plugins.qdoc @@ -55,13 +55,13 @@ OS X, see \l{Configuring Qt Designer Plugins on OS X}. 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}. The standalone \QD is part of the Qt library used for building projects, located under \c {%SDK%\qt}. Therefore, it fetches plugins from the 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}. \section2 Configuring Qt Designer Plugins on OS X @@ -133,7 +133,7 @@ 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 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. To use \QD plugins that were built for the shipped Qt version, make sure diff --git a/doc/src/winrt/creator-winrt.qdoc b/doc/src/winrt/creator-winrt.qdoc index 58228be6e5..91d0f32d46 100644 --- a/doc/src/winrt/creator-winrt.qdoc +++ b/doc/src/winrt/creator-winrt.qdoc @@ -41,8 +41,8 @@ \list 1 - \li Select \gui Help > \gui {About Plugins} > \gui {Device Support} > - \gui WinRT to enable the experimental Windows Runtime plugin. + \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {Device Support} > + \uicontrol WinRT to enable the experimental Windows Runtime 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 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 Runtime devices (the local computer, for now), Windows Phones, or the Windows Phone emulator. \endlist - \li Select \gui Run to specify run settings. + \li Select \uicontrol Run to specify run settings. Usually, you can use the default settings. |