aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/widgets
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2014-12-11 15:43:19 +0100
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2014-12-12 10:26:59 +0100
commite1fbeedcd4e47cb83d00173907607236b06c8ff6 (patch)
treed34c4961794c6406d05f36aacf215da3ce179a27 /doc/src/widgets
parentc9696aa6f4e1a737e3445702b138b2c0a2bd85ce (diff)
Doc: use \uicontrol command instead of \gui macro
Change-Id: Idc898b6ac70b6d3186d353086b5f3e45830d1f83 Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'doc/src/widgets')
-rw-r--r--doc/src/widgets/qtdesigner-app-tutorial.qdoc104
-rw-r--r--doc/src/widgets/qtdesigner-overview.qdoc38
-rw-r--r--doc/src/widgets/qtdesigner-plugins.qdoc6
3 files changed, 74 insertions, 74 deletions
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