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

Doc: replace remaining \gui commands with \uicontrol

Browse Source 
Missed the Extending Qt Creator Manual the last time I did this.

Change-Id: I33b9b59ef204d0f7c6a5f98665c4839c6646c9b1
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
This commit is contained in:
Leena Miettinen
2014-12-17 17:15:42 +01:00
committed by Eike Ziller
parent ce8ad44692
commit 4243c24754
9 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/coding-style.qdoc
+1 -1
View File
@@ -676,7 +676,7 @@
For example, the Find plugin provides the FindFilter interface for
other plugins to implement. With the FindFilter interface, additional search
scopes can be added, that appear in the \gui {Advanced Search} dialog. The
scopes can be added, that appear in the \uicontrol {Advanced Search} dialog. The
Find plugin retrieves all FindFilter implementations from the global
object pool and presents them in the dialog. The plugin forwards the
actual search request to the correct FindFilter implementation, which
doc/api/external-tool-spec.qdoc
+1 -1
View File
@@ -23,7 +23,7 @@
\title External Tool Specification Files
An external tool specification file describes a tool that can be run from
the \gui { Tools > External } menu.
the \uicontrol { Tools > External } menu.
It specifies the name of the tool, the executable to run, optional
arguments, and how to handle the output from the tool.
doc/api/first-plugin.qdoc
+22 -22
View File
@@ -42,11 +42,11 @@
version that it was created with.
\list 1
\li Select \gui{File > New File or Project > Library > Qt Creator Plugin > Choose}.
\li Select \uicontrol{File > New File or Project > Library > Qt Creator Plugin > Choose}.
\image firstplugin-wizard.png "Choose the \QC Plugin Wizard"
The \gui{Introduction and Project Location} dialog opens.
The \uicontrol{Introduction and Project Location} dialog opens.
\image firstplugin-nameandpath.png "Choose Name and Place of the Project"
@@ -55,62 +55,62 @@
from the project name. You will choose that name later in the wizard.
Continue to the next page.
The \gui{Kit Selection} dialog opens.
The \uicontrol{Kit Selection} dialog opens.
\image firstplugin-kitselection.png "Choose the kit to build and run your project with"
\li Select the \l{glossary-buildandrun-kit}{kit} to build and run your project with.
For a \QC plugin this needs to be a kit with \gui{Desktop} device type,
For a \QC plugin this needs to be a kit with \uicontrol{Desktop} device type,
and a Qt version that is compatible with the Qt version that your
\QC was built with (in the best case the exact same build).
If you use an incompatible Qt version to build your plugin, you
will get errors while \QC tries to load your plugin.
Continue to the next page.
The \gui{Plugin Information} dialog opens.
The \uicontrol{Plugin Information} dialog opens.
\image firstplugin-pluginsetup.png "Specify Your Plugin Details"
\li In the \gui{Plugin name} field, type \gui{Example}. The name of the plugin
\li In the \uicontrol{Plugin name} field, type \uicontrol{Example}. The name of the plugin
is used as its identifier, and also is the base for the file names and
classes in the code.
\li The values of the following fields are mainly informational, and
are shown in the detailed view in \QC's plugin overview
(\gui{Help > About Plugins}, or \gui{Qt Creator > About Plugins}
(\uicontrol{Help > About Plugins}, or \uicontrol{Qt Creator > About Plugins}
on Mac).
\list
\li \gui{Vendor name} is a short one-word name of the company
\li \uicontrol{Vendor name} is a short one-word name of the company
or organization that created the plugin. This is also used for
the path name where the plugin will be deployed to.
\li \gui{Copyright} is a one-line, short copyright string.
\li \gui{License} is a multi-line license text (but shouldn't be pages over pages long,
\li \uicontrol{Copyright} is a one-line, short copyright string.
\li \uicontrol{License} is a multi-line license text (but shouldn't be pages over pages long,
since the interface doesn't allow nice reading of long texts).
\li \gui{Description} is a relatively short, but
\li \uicontrol{Description} is a relatively short, but
possibly multi-line description of what the plugin does.
\li \gui{URL} is a website where the user can find more
\li \uicontrol{URL} is a website where the user can find more
information about the plugin and/or organization providing it.
\endlist
\li Set the \gui{Qt Creator sources} and \gui{Qt Creator build} fields to
\li Set the \uicontrol{Qt Creator sources} and \uicontrol{Qt Creator build} fields to
the source and build directory of the \QC
instance you want to use to test your plugin with, respectively.
If you don't do that correctly you will get compile errors for your
plugin, and your plugin might not show up in \QC at all.
\li In the \gui{Deploy into} list, select \gui{Qt Creator build}. This sets
\li In the \uicontrol{Deploy into} list, select \uicontrol{Qt Creator build}. This sets
your .pro file up to deploy your plugin directly into your \QC build's
plugin directory (requires you to have write permissions there).
The other option, \gui{Local user settings}, sets your .pro file up to
The other option, \uicontrol{Local user settings}, sets your .pro file up to
deploy your plugin into \QC's user plugin path
(for example \c{~/.config/QtProject/qtcreator/plugins} on Unix systems).
We choose \gui{Qt Creator build} because we use a self-compiled
We choose \uicontrol{Qt Creator build} because we use a self-compiled
\QC, and want the plugin to be only loaded by that \QC
instance.
Continue to the next page.
The \gui{Project Management} dialog opens.
The \uicontrol{Project Management} dialog opens.
\image firstplugin-summary.png "Summary of Created Files"
@@ -129,10 +129,10 @@
\image firstplugin-runsettings.png "Specify the Executable to Run"
Select the path to the \QC executable from the build that you specified
in the \gui{Qt Creator build} setting in the project wizard and click \gui OK.
in the \uicontrol{Qt Creator build} setting in the project wizard and click \uicontrol OK.
\QC starts up, and you can verify that your plugin successfully loaded
by looking for a menu entry \gui{Tools > Example} and by looking for
the plugin in the \gui{About Plugins} dialog.
by looking for a menu entry \uicontrol{Tools > Example} and by looking for
the plugin in the \uicontrol{About Plugins} dialog.
\image firstplugin-menuitem.png "Menu Registered by the Plugin"
@@ -323,12 +323,12 @@
\snippet exampleplugin/exampleplugin.cpp add menu
Here a new menu item is created, the created command added to it, and the menu
added to the \gui{Tools} menu in the menu bar. Again, this is covered in more
added to the \uicontrol{Tools} menu in the menu bar. Again, this is covered in more
detail in \l{Menus and Menu Items}.
\snippet exampleplugin/exampleplugin.cpp slot implementation
This part defines the code that is called when the menu item is triggered.
It uses the Qt API to open a message box that displays informative text and
an \gui OK button.
an \uicontrol OK button.
*/
doc/api/plugin-metadata.qdoc
+2 -2
View File
@@ -78,7 +78,7 @@
\li Required
\li Boolean
\li Optional. Defaults to \c false.
Is used as a hint for the \gui{About Plugins...} dialog, that the user may not
Is used as a hint for the \uicontrol{About Plugins...} dialog, that the user may not
manually disable this plugin. Only used for the Core plugin.
\row
\li Platform
@@ -100,7 +100,7 @@
\li Category
\li String
\li Defaults to \c Utilities. Is used to put related plugins
under the same tree node in the plugin overview \gui{About Plugins...}.
under the same tree node in the plugin overview \uicontrol{About Plugins...}.
\row
\li Vendor
\li String
doc/api/qtcreator-api.qdoc
+2 -2
View File
@@ -202,12 +202,12 @@
\li \l{Core::INavigationWidgetFactory}
\row
\li Add an options page to the \gui Options dialog.
\li Add an options page to the \uicontrol Options dialog.
\li Add a new page to existing or new category in Tools > Options.
\li \l{Core::IOptionsPage}
\row
\li Add a find filter to the \gui Find dialog.
\li Add a find filter to the \uicontrol Find dialog.
\li Implement any kind of search term based search.
\li \l{Find::IFindFilter}, \l{Core::SearchResultWindow}
doc/api/qtcreator-dev-wizards.qdoc
+4 -4
View File
@@ -42,7 +42,7 @@
\endlist
\li Providing a set of parameters that determine how the wizard shows up
in the list of wizards in the \gui{New File or Project} dialog.
in the list of wizards in the \uicontrol{New File or Project} dialog.
When deriving from Core::IWizard, virtual functions returning the
values have to be implemented.
@@ -117,7 +117,7 @@
\section2 Parameters
The parameters listed below determine how the wizard shows up
in the list of wizards in the \gui{New File or Project} dialog.
in the list of wizards in the \uicontrol{New File or Project} dialog.
Wizards in Qt Creator are grouped by categories.
@@ -190,7 +190,7 @@
On top of that, we implement validation logic to ensure content is entered.
We implement QWizardPage::isComplete() to return true when both input widgets
have contents, enabling the \gui{Next} button. For this to happen
have contents, enabling the \uicontrol{Next} button. For this to happen
as the user enters text, we need to connect to the changed() signal of the
controls and emit QWizardPage::completeChanged() once the complete status changes.
@@ -227,7 +227,7 @@
\section2 Plugin Registration
In order for the wizard to be found by the \gui{New} dialog, we need to
In order for the wizard to be found by the \uicontrol{New} dialog, we need to
register it with ExtensionSystem::PluginManager, which also takes care
of deleting it:
doc/api/qtcreator-dev.qdoc
+3 -3
View File
@@ -60,7 +60,7 @@
\section2 File, Class and Project Templates
You can extend the wizards in \gui {File > New File or Project} with your
You can extend the wizards in \uicontrol {File > New File or Project} with your
own
file and project templates by writing XML definition files for them.
\list
@@ -187,7 +187,7 @@
tool. If starting the tool and handling its output require more complex
logic, you can add a menu item to Qt Creator with a plugin.
If you need a way to configure the tool in Qt Creator, you can add an
\gui Options page for it.
\uicontrol Options page for it.
\list
\li \l{http://doc.qt.digia.com/qtcreator/creator-editor-external.html}
{Using External Tools}
@@ -211,7 +211,7 @@
file, which is then opened within Qt Creator. You provide
an editor (probably read-only) for handling this file.
For lists of issues, consider creating task list files which are shown in
the \gui {Issues} output
the \uicontrol {Issues} output
pane.
\list
\li \l{http://doc.qt.digia.com/qtcreator/creator-task-lists.html}
doc/api/qtcreator-documentation.qdoc
+2 -2
View File
@@ -242,7 +242,7 @@
Compare the initial and optimized images to check that image quality is
preserved. If the image quality deteriorates, do not use color reduction
(select the \gui {True Color} option, instead).
(select the \uicontrol {True Color} option, instead).
You can also see the sizes of the initial and optimized image.
@@ -294,7 +294,7 @@
\c {share/doc/qtcreator} directory in the \QC build directory on Windows and
Linux, and in the \c {bin/Qt Creator.app/Contents/Resources/app} directory
on OS X. You can view the HTML files in a browser and the help files in
the \QC \gui Help mode. For more information about adding the help files to
the \QC \uicontrol Help mode. For more information about adding the help files to
\QC, see
\l{http://qt-project.org/doc/qtcreator/creator-help.html#adding-external-documentation}
{Adding External Documentation}.
doc/api/qtcreator-ui-text.qdoc
+10 -10
View File
@@ -86,7 +86,7 @@
from the user or carries special weight.
\li Use quotation marks ("") around variable values. For example,
\gui {Close Project "qtcreator"}.
\uicontrol {Close Project "qtcreator"}.
For consistency, use double quotes to emphasize or set apart file
names, directory names, URLs, and so on, in user visible strings.
@@ -121,14 +121,14 @@
short, canonical HTML in the source tab of the rich text editor:
\c {<html><head/><body><b>Note:</b> text.}
In Qt 4.7, use only the \gui Source tab of the Qt Designer rich text
In Qt 4.7, use only the \uicontrol Source tab of the Qt Designer rich text
editor. The automatic conversion performed by the rich text editor tab
generates a lot of redundant stylesheet information and uses hard-coded
fonts that look bad on other platforms and make translation in Qt Linguist
difficult.
Qt Designer 4.8 has a feature that simplifies the rich text (on by
default), but still, you should verify by looking at the \gui Source tab.
default), but still, you should verify by looking at the \uicontrol Source tab.
\section2 Writing Messages
@@ -197,7 +197,7 @@
\li Enter the UI text in the field.
\li Click \gui Convert.
\li Click \uicontrol Convert.
\endlist
@@ -357,9 +357,9 @@
\image qtcreator-dialog.png "Dialog"
\li Use the menu item or button name as the dialog name. You can
also combine the menu item or button name and the name of the
object that is managed in the dialog. For example, the \gui Add
button in the \gui Documentation options opens the
\gui {Add Documentation} dialog.
object that is managed in the dialog. For example, the \uicontrol Add
button in the \uicontrol Documentation options opens the
\uicontrol {Add Documentation} dialog.
\row
\li Locator
\li Allows you to browse not only files, but any items defined by
@@ -398,7 +398,7 @@
\image qtcreator-mode-selector.png "Mode selector"
\li You can add a mode for a new type of editor, for example.
Use descriptive, but short mode names. They have to fit in the
\gui {Mode selector}.
\uicontrol {Mode selector}.
\row
\li Output pane
\li A pane displayed in the task pane that displays output from Qt Creator.
@@ -406,7 +406,7 @@
\li Use descriptive names for output panes.
\row
\li Sidebar
\li A view available in the \gui Edit and \gui Debug modes that
\li A view available in the \uicontrol Edit and \uicontrol Debug modes that
you can use to browse projects, files, and bookmarks, and to
view the class hierarchy.
\image qtcreator-sidebar-menu.png "Sidebar"
@@ -416,7 +416,7 @@
\li View
\li An area of the screen that displays information for users and
provides them with functions for managing the information.
Available in \gui Debug mode, for interaction with the program
Available in \uicontrol Debug mode, for interaction with the program
that is running under the control of the debugger.
\image qtcreator-debugger-views.png "Views"
\li Use descriptive names for views.