From c0704c2091d603e67ba42bff8c4a6c9717deb8a4 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@digia.com>
Date: Mon, 25 Nov 2013 17:37:19 +0100
Subject: [PATCH] Doc: use cross-linking to Qt module documentation
Replace links to "\l{http://qt-project.org/doc/"
with links to topic titles. Remove links where QDoc
creates them automatically based on the .index files.
Add the .index files for the modules that are discussed
in the Qt Creator Manual.
Note: the links will only be generated if the Qt used to
build the docs contains the linked modules and documentation
(.index file) has been generated for them.
Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
---
doc/config/qtcreator-project.qdocconf | 15 ++-
doc/src/android/androiddev.qdoc | 3 +-
.../android/creator-android-app-tutorial.qdoc | 2 +-
doc/src/android/deploying-android.qdoc | 6 +-
.../debugger/qtquick-debugger-example.qdoc | 2 +-
doc/src/howto/creator-cli.qdoc | 4 +-
doc/src/howto/creator-external-tools.qdoc | 4 +-
doc/src/howto/creator-help.qdoc | 4 +-
.../creator-deployment-madde.qdoc | 3 +-
doc/src/overview/creator-glossary.qdoc | 4 +-
doc/src/overview/creator-overview.qdoc | 3 +-
.../projects/creator-projects-creating.qdoc | 13 +-
.../projects/creator-projects-libraries.qdoc | 3 +-
.../projects/creator-projects-overview.qdoc | 2 +-
doc/src/qnx/creator-deployment-qnx.qdoc | 3 +-
doc/src/qtquick/qtquick-app-tutorial.qdoc | 4 +-
doc/src/qtquick/qtquick-buttons.qdoc | 6 +-
doc/src/qtquick/qtquick-components.qdoc | 20 ++-
doc/src/qtquick/qtquick-designer.qdoc | 8 +-
.../qtquick/qtquick-modules-with-plugins.qdoc | 11 +-
doc/src/qtquick/qtquick-screens.qdoc | 126 +++++++-----------
doc/src/qtquick/qtquick-toolbars.qdoc | 11 +-
doc/src/widgets/qtdesigner-app-tutorial.qdoc | 12 +-
doc/src/widgets/qtdesigner-overview.qdoc | 3 +-
doc/src/widgets/qtdesigner-plugins.qdoc | 6 +-
25 files changed, 111 insertions(+), 167 deletions(-)
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf
index e7bc6a8ea73..e73ab8ba1fb 100644
--- a/doc/config/qtcreator-project.qdocconf
+++ b/doc/config/qtcreator-project.qdocconf
@@ -10,7 +10,20 @@ exampledirs = $SRCDIR/examples \
indexes += $QT_INSTALL_DOCS/qtwidgets/qtwidgets.index \
$QT_INSTALL_DOCS/qtcore/qtcore.index \
$QT_INSTALL_DOCS/qtqml/qtqml.index \
- $QT_INSTALL_DOCS/qtquick/qtquick.index
+ $QT_INSTALL_DOCS/qtquick/qtquick.index \
+ $QT_INSTALL_DOCS/qmake/qmake.index \
+ $QT_INSTALL_DOCS/qtdesigner/qtdesigner.index \
+ $QT_INSTALL_DOCS/qtdoc/qtdoc.index \
+ $QT_INSTALL_DOCS/qtgui/qtgui.index \
+ $QT_INSTALL_DOCS/qthelp/qthelp.index \
+ $QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index \
+ $QT_INSTALL_DOCS/qtquicklayouts/qtquicklayouts.index \
+ $QT_INSTALL_DOCS/qtlinguist/qtlinguist.index \
+ $QT_INSTALL_DOCS/qtscript/qtscript.index \
+ $QT_INSTALL_DOCS/qtsensors/qtsensors.index \
+ $QT_INSTALL_DOCS/qtuitools/qtuitools.index \
+ $QT_INSTALL_DOCS/qtwebkit/qtwebkit.index \
+ $QT_INSTALL_DOCS/qtxml/qtxml.index
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)
diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc
index c72474d7ca1..56a535a9573 100644
--- a/doc/src/android/androiddev.qdoc
+++ b/doc/src/android/androiddev.qdoc
@@ -142,8 +142,7 @@
SDK to get the API and tools packages needed for development. In addition,
you must install Qt for Android as part of Qt 5.2, or later.
- For more information, see
- \l{http://qt-project.org/doc/qt-5/android-support.html}{Qt for Android}.
+ For more information, see \l{Qt for Android}.
To configure connections between \QC and Android devices:
diff --git a/doc/src/android/creator-android-app-tutorial.qdoc b/doc/src/android/creator-android-app-tutorial.qdoc
index 7f8cf616dcd..40ff2242350 100644
--- a/doc/src/android/creator-android-app-tutorial.qdoc
+++ b/doc/src/android/creator-android-app-tutorial.qdoc
@@ -155,7 +155,7 @@
import QtSensors 5.0
\endcode
- \li Add the Accelerometer type with the necessary properties:
+ \li Add the \l{Accelerometer} type with the necessary properties:
\quotefromfile accelbubble/main.qml
\skipto Accelerometer
diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc
index 758687f86cf..6d72012e0c9 100644
--- a/doc/src/android/deploying-android.qdoc
+++ b/doc/src/android/deploying-android.qdoc
@@ -154,8 +154,7 @@
For more information, see \l{Selecting Android Devices}.
For more information about the \c androiddeployqt tool, see
- \l{http://qt-project.org/doc/qt-5/deployment-android.html}
- {Deploying an Application on Android}.
+ \l{Deploying an Application on Android}.
\section2 Specifying Settings for Qt 5 Packages
@@ -168,8 +167,7 @@
The anddroiddeployqt tool uses the information in the project .pro file to
create APKs. For more information about the qmake variables
that you can set in the .pro file to tailor the APK, see
- \l{http://qt-project.org/doc/qt-5/deployment-android.html#qmake-variables}
- {qmake Variables}.
+ \l{Deploying an Application on Android#qmake-variables}{qmake Variables}.
You can view information about what the anddroiddeployqt tool is doing in
the \gui {Compile Output} pane. To view additional information, select the
diff --git a/doc/src/debugger/qtquick-debugger-example.qdoc b/doc/src/debugger/qtquick-debugger-example.qdoc
index fb770842c5d..21d242c91c7 100644
--- a/doc/src/debugger/qtquick-debugger-example.qdoc
+++ b/doc/src/debugger/qtquick-debugger-example.qdoc
@@ -31,7 +31,7 @@
\title Debugging a Qt Quick Example Application
This section uses the
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick2-qml-advtutorial.html}{Same Game}
+ \l{QML Advanced Tutorial}{Same Game}
example application to illustrate how to debug Qt Quick applications in the
\gui Debug mode.
diff --git a/doc/src/howto/creator-cli.qdoc b/doc/src/howto/creator-cli.qdoc
index 75b42ea8d74..7dbc28bc4a7 100644
--- a/doc/src/howto/creator-cli.qdoc
+++ b/doc/src/howto/creator-cli.qdoc
@@ -161,11 +161,11 @@
\section1 Using Custom Styles
- \QC is a \l{http://qt-project.org/doc/qt-5.0/qtwidgets/qapplication.html#QApplication}
+ \QC is a \l{QApplication}
{Qt application}, and therefore, it accepts the command line options
that all Qt applications accept. For example, you can use the \c {-style} and
\c {-stylesheet} options to apply custom styles and
- \l{http://qt-project.org/doc/qt-5.0/qtwidgets/stylesheet.html}{stylesheets}.
+ \l{QApplication#stylesheet}{stylesheets}.
The styling is only applied during the current session.
Exercise caution when applying styles, as overriding the existing styling
diff --git a/doc/src/howto/creator-external-tools.qdoc b/doc/src/howto/creator-external-tools.qdoc
index 14e8e716b19..dbe1d0f4318 100644
--- a/doc/src/howto/creator-external-tools.qdoc
+++ b/doc/src/howto/creator-external-tools.qdoc
@@ -55,9 +55,7 @@
specify other command line arguments for the tools, select \gui {Tools >
External > Configure}.
- For more information about Qt Linguist, see
- \l{http://qt-project.org/doc/qt-5.0/qtlinguist/qtlinguist-index.html}
- {Qt Linguist Manual}.
+ For more information about Qt Linguist, see \l{Qt Linguist Manual}.
\section1 Previewing QML Files
diff --git a/doc/src/howto/creator-help.qdoc b/doc/src/howto/creator-help.qdoc
index 8dd0bc8b167..5af48f23e87 100644
--- a/doc/src/howto/creator-help.qdoc
+++ b/doc/src/howto/creator-help.qdoc
@@ -177,9 +177,7 @@
\li Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
- .qch file, see
- \l{http://qt-project.org/doc/qt-5.0/qthelp/qthelp-framework.html}
- {The Qt Help Framework}.
+ .qch file, see \l{The Qt Help Framework}.
\li To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
diff --git a/doc/src/linux-mobile/creator-deployment-madde.qdoc b/doc/src/linux-mobile/creator-deployment-madde.qdoc
index 4b211ed6516..52b414c73e1 100644
--- a/doc/src/linux-mobile/creator-deployment-madde.qdoc
+++ b/doc/src/linux-mobile/creator-deployment-madde.qdoc
@@ -42,8 +42,7 @@
field displays the location of the file on the development PC. The
\gui {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{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#installs}
+ missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files.
When you run the application, \QC copies the necessary files to the device
diff --git a/doc/src/overview/creator-glossary.qdoc b/doc/src/overview/creator-glossary.qdoc
index fd48a0845bc..9f10a033bec 100644
--- a/doc/src/overview/creator-glossary.qdoc
+++ b/doc/src/overview/creator-glossary.qdoc
@@ -67,9 +67,7 @@
contained in a .qml file. For instance, a Button component may
be defined in Button.qml. The QML runtime may instantiate this
Button component to create Button objects. Alternatively, a
- component may be defined inside a
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qml-qtquick2-component.html}
- {Component} QML type.
+ component may be defined inside a \l{Component} QML type.
\row
\li Deploy configuration
diff --git a/doc/src/overview/creator-overview.qdoc b/doc/src/overview/creator-overview.qdoc
index bbe95a1cec6..952e247eca4 100644
--- a/doc/src/overview/creator-overview.qdoc
+++ b/doc/src/overview/creator-overview.qdoc
@@ -59,8 +59,7 @@
\QC provides two integrated visual editors, \QMLD and \QD.
To create intuitive, modern-looking, fluid user interfaces, you
- can use \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}
- {Qt Quick}.
+ can use \l{Qt Quick}.
If you need a traditional user interface that is clearly
structured and enforces a platform look and feel, you can use
the integrated \QD. For more information, see
diff --git a/doc/src/projects/creator-projects-creating.qdoc b/doc/src/projects/creator-projects-creating.qdoc
index 613eae6a3f4..895fcf9f16e 100644
--- a/doc/src/projects/creator-projects-creating.qdoc
+++ b/doc/src/projects/creator-projects-creating.qdoc
@@ -55,8 +55,7 @@
process for development projects across different platforms. qmake
automates the generation of build configurations so that only a few lines
of information are needed to create each configuration. For more
- information about qmake, see the
- \l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-manual.html}{qmake Manual}.
+ information about qmake, see the \l{qmake Manual}.
You can modify the build and run settings for qmake projects in the
\gui Projects mode.
@@ -327,11 +326,12 @@
Qt provides support for integration with OpenGL implementations on all
platforms, which allows you to display hardware accelerated 3D graphics
alongside a more conventional user interface. For more information, see
- \l{http://qt-project.org/doc/qt-5.0/qtopengl/qtopengl-index.html}{Qt OpenGL}.
+ \l{Qt Gui#opengl-and-opengl-es-integration}{OpenGL and OpenGL ES integration}.
- You can use the QGLShader class to compile OpenGL shaders written in the
+ You can use the QOpenGLShader class to compile OpenGL shaders written in the
OpenGL Shading Language (GLSL) and in the OpenGL/ES Shading Language
- (GLSL/ES). QGLShader and QGLShaderProgram shelter you from the details of
+ (GLSL/ES). QOpenGLShader and QOpenGLShaderProgram shelter you from the
+ details of
compiling and linking vertex and fragment shaders.
You can use \QC code editor to write fragment and vertex shaders
@@ -380,8 +380,7 @@
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{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#subdirs}
+ and the subproject that you add as a value of the \l{Variables#subdirs}
{SUBDIRS variable}. It also adds all the necessary files for the subproject.
To add more subprojects, right-click the project name in the \gui Projects
diff --git a/doc/src/projects/creator-projects-libraries.qdoc b/doc/src/projects/creator-projects-libraries.qdoc
index e95b8d27f30..c38952b619b 100644
--- a/doc/src/projects/creator-projects-libraries.qdoc
+++ b/doc/src/projects/creator-projects-libraries.qdoc
@@ -90,8 +90,7 @@
\endlist
For more information about the project file settings, see
- \l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-project-files.html#declaring-other-libraries}
- {Declaring Other Libraries}.
+ \l{Declaring Other Libraries}.
\section1 Example of Adding Internal Libraries
diff --git a/doc/src/projects/creator-projects-overview.qdoc b/doc/src/projects/creator-projects-overview.qdoc
index a72d16a9df5..594cb016fd5 100644
--- a/doc/src/projects/creator-projects-overview.qdoc
+++ b/doc/src/projects/creator-projects-overview.qdoc
@@ -60,7 +60,7 @@
{shadow builds} are used to keep the build specific files separate
from the source. You can create separate versions of project files
to keep platform-dependent code separate. You can use qmake
- \l{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-tutorial.html#adding-platform-specific-source-files}
+ \l{Adding Platform Specific Source Files}
{scopes} to select the file to process depending on which platform
qmake is run on.
diff --git a/doc/src/qnx/creator-deployment-qnx.qdoc b/doc/src/qnx/creator-deployment-qnx.qdoc
index 8a60e568e9a..15bed070e85 100644
--- a/doc/src/qnx/creator-deployment-qnx.qdoc
+++ b/doc/src/qnx/creator-deployment-qnx.qdoc
@@ -72,8 +72,7 @@
field displays the location of the file on the development PC. The
\gui {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{http://qt-project.org/doc/qt-5.0/qtdoc/qmake-variable-reference.html#installs}
+ missing. Edit the qmake \l{Variables#installs}
{INSTALLS variable} in the project .pro file to add the missing files.
When you run the application, \QC copies the necessary files to the device
diff --git a/doc/src/qtquick/qtquick-app-tutorial.qdoc b/doc/src/qtquick/qtquick-app-tutorial.qdoc
index b362f770613..8bb8df685b6 100644
--- a/doc/src/qtquick/qtquick-app-tutorial.qdoc
+++ b/doc/src/qtquick/qtquick-app-tutorial.qdoc
@@ -31,10 +31,10 @@
\title Creating a Qt Quick Application
This tutorial uses built-in QML types and illustrates basic concepts of
- \l {http://qt-project.org/doc/qt-5.0/qtquick/qtquick-index.html}{Qt Quick}.
+ \l{Qt Quick}.
This tutorial describes how to use \QC to implement Qt states and transitions. We use
- \l{http://qt-project.org/doc/qt-5.0/qtquick/animation.html}{Qt example code} to
+ \l{Animation}{Qt example code} to
create an application that displays a Qt logo that moves between three rectangles on the
page when you click them.
diff --git a/doc/src/qtquick/qtquick-buttons.qdoc b/doc/src/qtquick/qtquick-buttons.qdoc
index 96c8daa911b..8aa8e065613 100644
--- a/doc/src/qtquick/qtquick-buttons.qdoc
+++ b/doc/src/qtquick/qtquick-buttons.qdoc
@@ -91,8 +91,7 @@
\endlist
To create a graphical button that scales beautifully without using vector
- graphics, use the \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
- {Border Image} type. For more information, see
+ graphics, use the \l{BorderImage} type. For more information, see
\l{Creating Scalable Buttons and Borders}.
*/
@@ -108,8 +107,7 @@
\title Creating Scalable Buttons and Borders
You can use the
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
- {Border Image} type to display an image, such as a PNG file, as a border
+ \l{BorderImage} type to display an image, such as a PNG file, as a border
and a background.
Use two Border Image items and suitable graphics to make it look like the
diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc
index a1af53241a3..c71cea94861 100644
--- a/doc/src/qtquick/qtquick-components.qdoc
+++ b/doc/src/qtquick/qtquick-components.qdoc
@@ -41,36 +41,32 @@
\list
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}
- {Border Image}
- uses an image as a border or background.
+ \li \l{BorderImage} uses an image as a border or background.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image}
+ \li \l{Image}
adds a bitmap to the scene. You can stretch and tile images.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html}{Item}
+ \li \l{Item}
is the most basic of all visual types in QML. Even though it has no
visual appearance, it defines all the properties that are common
across visual types, such as the x and y position, width and height,
anchoring, and key handling.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle}
+ \li \l{Rectangle}
adds a rectangle that is painted with a solid fill color and an
optional border. You can also use the radius property to create
rounded rectangles.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text}
- adds formatted read-only text.
+ \li \l{Text} adds formatted read-only text.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textedit.html}{Text Edit}
+ \li \l{TextEdit}
adds a single line of editable formatted text that can be validated.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-textinput.html}{Text Input}
+ \li \l{TextInput}
adds a single line of editable plain text that can be validated.
\omit
- \li \l{http://qt-project.org/doc/qt-5.0/qtwebkit/qml-qtwebkit3-webview.html}{Web View}
- adds web content to a canvas.
+ \li \l{WebView} adds web content to a canvas.
\endomit
\endlist
diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc
index 8553d4cea18..05a44cbc81d 100644
--- a/doc/src/qtquick/qtquick-designer.qdoc
+++ b/doc/src/qtquick/qtquick-designer.qdoc
@@ -105,7 +105,7 @@
\section2 Setting the Stacking Order
- The \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-item.html#z-prop}{z property} of an
+ The \l{Item#z-prop}{z property} of an
item determines its position in relation to its sibling items in the
type hierarchy. By default, items with a higher stacking value are
drawn on top of siblings with a lower stacking value. Items with the same
@@ -334,8 +334,7 @@
transformations to an item. Each transformation is applied in order, one at
a time.
- For more information on Transform types, see
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-transform.html}{Transform}.
+ For more information on Transform types, see \l{Transform}.
\section1 Adding States
@@ -373,8 +372,7 @@
\endlist
- The \gui State pane displays the different
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-state.html}{states}
+ The \gui State pane displays the different \l{State}{states}
of the component in the Qt Quick Designer.
\image qmldesigner-transitions.png "State pane"
diff --git a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
index 7536b1cba2a..8849b865a15 100644
--- a/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
+++ b/doc/src/qtquick/qtquick-modules-with-plugins.qdoc
@@ -36,11 +36,9 @@
information for code completion and the semantic checks to work correctly.
When you write a QML module or use QML from a C++ application you typically
- register new types with
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlengine.html#qmlRegisterType}
- {qmlRegisterType} or expose some class instances with
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qqmlcontext.html#setContextProperty}
- {setContextProperty}. The \QC C++ code model now scans for these calls and
+ register new types with \l{QQmlEngine#qmlRegisterType-3}{qmlRegisterType()} or expose some
+ class instances with \l{QQmlContext::setContextProperty()}. The \QC C++
+ code model now scans for these calls and
tells the QML code model about them. This means that properties are
displayed during code completion and the JavaScript code checker does not
complain about unknown types. However, this works only when the source code
@@ -55,8 +53,7 @@
For Qt 4.8 and later, one or more \c qmltypes files can be listed in the
\c qmldir file under the \c typeinfo header. These files will be read in
addition to \c{plugins.qmltypes}. For more information, see
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-modules-qmldir.html#writing-a-qmltypes-file}
- {Writing a qmltypes File}.
+ \l{Writing a qmltypes File}.
\section1 Generating qmltypes Files
diff --git a/doc/src/qtquick/qtquick-screens.qdoc b/doc/src/qtquick/qtquick-screens.qdoc
index 09651902a3f..1dc04d2397e 100644
--- a/doc/src/qtquick/qtquick-screens.qdoc
+++ b/doc/src/qtquick/qtquick-screens.qdoc
@@ -62,23 +62,19 @@
\section1 Using Data Models
You can create the following types of views to organize items provided by
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-modelviewsdata-modelview.html}{data models}:
+ \l{Models and Views in Qt Quick}{data models}:
\list
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-gridview.html}{Grid View}
- provides a grid vizualization of a model.
+ \li GridView provides a grid vizualization of a model.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-listview.html}{List View}
- provides a list vizualization of a model.
+ \li ListView provides a list vizualization of a model.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-pathview.html}{Path View}
- visualizes the contents of a model along a path.
+ \li PathView visualizes the contents of a model along a path.
\endlist
- When you add a Grid View, List View, or Path View, the
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-listmodel.html}{ListModel} and the
+ When you add a GridView, ListView, or PathView, the ListModel and the
delegate component that creates an instance for each item in the model are
added automatically. You can edit item properties
in the \gui Properties pane or
@@ -89,7 +85,7 @@
The position of an item on the canvas can be either absolute or relative
to other items. If you are designing a static user interface,
- \l{http://dev.qt-project.org/doc/qt-5.0/qtquick-positioning-topic.html#manual-positioning}
+ \l{Important Concepts In Qt Quick - Positioning#manual-positioning}
{manual positioning} provides the most efficient form of positioning items
on the screen. For a dynamic user interface, you can employ the following
positioning methods provided by Qt Quick:
@@ -110,7 +106,7 @@
\section2 Setting Bindings
- \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-topic.html#positioning-with-bindings}
+ \l{Positioning with Bindings}
{Property binding} is a declarative way of specifying the value of a property.
Binding allows a property value to be expressed as an JavaScript expression
that defines the value relative to other property values or data accessible
@@ -127,8 +123,7 @@
To remove bindings, select \gui Reset in the context menu.
For more information on the JavaScript environment provided by QML, see
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-javascript-topic.html}
- {Integrating QML and JavaScript}.
+ \l{Integrating QML and JavaScript}.
\QMLD cannot show bindings and using them might have a negative impact on
performance, so consider setting anchors and margins for items, instead.
@@ -138,8 +133,7 @@
\section2 Setting Anchors and Margins
- In an
- \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-anchors.html}
+ In an \l{Important Concepts In Qt Quick - Positioning#anchors}
{anchor-based} layout, each QML type can be thought of as having a set of
invisible \e anchor lines: top, bottom, left, right, fill, horizontal
center, vertical center, and baseline.
@@ -191,7 +185,7 @@
\section2 Using Positioners
- \l{http://qt-project.org/doc/qt-5.0/qtquick-positioning-layouts.html}
+ \l{Important Concepts In Qt Quick - Positioning#positioners}
{Positioner items} are container items that manage the positions of items in
a declarative user interface. Positioners behave in a similar way to the
layout managers used with standard Qt widgets, except that they are also
@@ -201,17 +195,15 @@
\list
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-column.html}{Column}
- arranges its child items vertically.
+ \li \l{Column} arranges its child items vertically.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-row.html}{Row}
- arranges its child items horizontally.
+ \li \l{Row} arranges its child items horizontally.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-grid.html}{Grid}
+ \li \l{Grid}
arranges its child items so that they are aligned in a grid and
are not overlapping.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flow.html}{Flow}
+ \li \l{Flow}
arranges its child items side by side, wrapping as necessary.
\endlist
@@ -222,28 +214,23 @@
\section2 Using Layouts
- From Qt 5.1, you can use QML types in the
- \l{http://qt-project.org/doc/qt-5.1/qtquicklayouts/qtquicklayouts-index.html}
- {Qt Quick Layouts module} to arrange Qt Quick items on screens. Unlike p
- ositioners, they manage both the positions and sizes of items in a
+ From Qt 5.1, you can use QML types in the \l{qtquicklayouts-index.html}
+ {Qt Quick Layouts} module to arrange Qt Quick items on screens. Unlike
+ positioners, they manage both the positions and sizes of items in a
declarative interface. They are well suited for resizable user interfaces.
You can use the following layout types to arrange items on screens:
\list
- \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-layout.html}
- {Layout} provides attached properties for items pushed onto a
+ \li \l{Layout} provides attached properties for items pushed onto a
\gui {Column Layout}, \gui {Row Layout}, or \gui {Grid Layout}.
- \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-columnlayout.html}
- {Column Layout} provides a grid layout with only one column.
+ \li ColumnLayout provides a grid layout with only one column.
- \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-rowlayout.html}
- {Row Layout} provides a grid layout with only one row.
+ \li RowLayout provides a grid layout with only one row.
- \li \l{http://qt-project.org/doc/qt-5.0/qml-qtquick-layouts-gridlayout.html}
- {Grid Layout} provides a way of dynamically arranging items in a
+ \li GridLayout provides a way of dynamically arranging items in a
grid.
\endlist
@@ -259,9 +246,8 @@
\section2 Using Split Views
- From Qt 5.1, you can use the
- \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-splitview.html}
- {Split View} Qt Quick Control to arrange items horizontally or vertically
+ From Qt 5.1, you can use the SplitView Qt Quick Control to arrange items
+ horizontally or vertically
with a draggable splitter between each item.
@@ -344,16 +330,14 @@
use different types of animated transitions. For example, you can animate
changes to property values and colors. You can use rotation animation to
control the direction of rotation. For more information, see
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick-statesanimations-animations.html}
- {Animation and Transitions in Qt Quick}.
+ \l{Animation and Transitions in Qt Quick}.
You can use the \c ParallelAnimation type to start several animations at
the same time. Or use the \c SequentialAnimation type to run them one
after another.
You can use the code editor to specify transitions. For more information,
- see \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-transition.html}
- {Transition}.
+ see \l{Transition}.
\section1 Adding User Interaction Methods
@@ -362,85 +346,70 @@
\list
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flickable.html}{Flickable}
+ \li \l{Flickable}
items can be flicked horizontally or vertically.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-flipable.html}{Flipable}
+ \li \l{Flipable}
items can be flipped between their front and back sides by using
rotation, state, and transition.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-focusscope.html}{Focus Scope}
+ \li FocusScope
assists in keyboard focus handling when building reusable QML
components.
- \li \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-mousearea.html}{Mouse Area}
- enables simple mouse handling.
+ \li MouseArea enables simple mouse handling.
\endlist
From Qt 5.1, you can also use the following
- \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qtquickcontrols-index.html}
- {Qt Quick Controls} to present or receive input from the user:
+ \l{Qt Quick Controls} to present or receive input from the user:
\list
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-button.html}
- {Button} provides a push button that you can associate with an
+ \li \l{Button} provides a push button that you can associate with an
action.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-checkbox.html}
- {Check Box} provides an option button that can be toggled on
+ \li CheckBox provides an option button that can be toggled on
(checked) or off (unchecked).
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-combobox.html}
- {Combo Box} provides a drop-down list. Add items to the combo box by
+ \li ComboBox provides a drop-down list. Add items to the combo box by
assigning it a ListModel, or a list of strings to the model
property.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-groupbox.html}
- {Group Box} provides a frame, a title on top, and place for various
+ \li GroupBox provides a frame, a title on top, and place for various
other controls inside the frame.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-label.html}
- {Label} provides a text label that follows the font and color scheme
+ \li \l{Label} provides a text label that follows the font and color scheme
of the system.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-progressbar.html}
- {Progress Bar} indicates the progress of an operation.
+ \li ProgressBar indicates the progress of an operation.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-radiobutton.html}
- {Radio Button} provides an option button that can be switched on
+ \li RadioButton provides an option button that can be switched on
(checked) or off (unchecked).
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-slider.html}
+ \li \l{Slider}
{Slider (Horizontal) and Slider (Vertical)} enable the user to move
a slider handle along a horizontal or vertical groove and translate
the handle's position into a value within the specified range.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-spinbox.html}
- {Spin Box} enables the user to specify a value by clicking the up or
+ \li SpinBox enables the user to specify a value by clicking the up or
down buttons, by pressing up or down on the keyboard, or by entering
a value in the box.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-statusbar.html}
- {Status Bar} contains status information in your application. It
+ \li StatusBar contains status information in your application. It
does not provide a layout of its own, but requires you to position
its contents, for instance by creating a \gui {Row Layout}.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-textarea.html}
- {Text Area} displays multiple lines of editable formatted text.
+ \li TextArea displays multiple lines of editable formatted text.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-textfield.html}
- {Text Field} displays a single line of editable plain text.
+ \li TextField displays a single line of editable plain text.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-toolbar.html}
- {Tool Bar} provides styling for ToolButton as well as other controls
+ \li ToolBar provides styling for ToolButton as well as other controls
that it can contain. However, it does not provide a layout of its
own, but requires you to position its contents, for instance by
creating a \gui {Row Layout}.
- \li \l{http://qt-project.org/doc/qt-5.1/qtquickcontrols/qml-qtquick-controls1-toolbutton.html}
- {Tool Button} provides a button that is functionally similar to
+ \li ToolButton provides a button that is functionally similar to
\gui Button, but that looks more suitable on a \gui {Tool Bar}.
\endlist
@@ -450,12 +419,9 @@
A user interface is only a part of an application, and not really useful by itself.
You can use Qt or JavaScript to implement the application logic. For more information on
- using JavaScript, see
- \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-javascript-topic.html}
- {Integrating QML and JavaScript}.
+ using JavaScript, see \l{Integrating QML and JavaScript}.
For an example of how to use JavaScript to develop a game, see the
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qtquick2-qml-advtutorial.html}
- {QML Advanced Tutorial}.
+ \l{QML Advanced Tutorial}.
*/
diff --git a/doc/src/qtquick/qtquick-toolbars.qdoc b/doc/src/qtquick/qtquick-toolbars.qdoc
index 6679a7cd985..f1d8353c7da 100644
--- a/doc/src/qtquick/qtquick-toolbars.qdoc
+++ b/doc/src/qtquick/qtquick-toolbars.qdoc
@@ -48,8 +48,7 @@
\section1 Previewing Images
The Qt Quick Toolbar for images allows you to edit the properties of
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-borderimage.html}{Border Image}
- and \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-image.html}{Image} items.
+ BorderImage and \l{Image} items.
You can scale and tile the images, replace them with other images,
preview them, and change the image margins.
@@ -63,7 +62,7 @@
\section1 Formatting Text
The Qt Quick Toolbar for text allows you to edit the properties of
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-text.html}{Text} items.
+ \l{Text} items.
You can change the font family and size as well as text formatting, style,
alignment, and color.
@@ -79,8 +78,7 @@
\section1 Previewing Animation
The Qt Quick Toolbar for animation allows you to edit the properties of
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-propertyanimation.html}
- {PropertyAnimation} items and the items that inherit it. You can
+ PropertyAnimation items and the items that inherit it. You can
change the easing curve type and duration. For some curves, you can also
specify amplitude, period, and overshoot values.
@@ -91,8 +89,7 @@
\section1 Editing Rectangles
The Qt Quick Toolbar for rectangles allows you to edit the properties of
- \l{http://qt-project.org/doc/qt-5.0/qtquick/qml-qtquick2-rectangle.html}{Rectangle}
- items. You can change the fill and border colors and add
+ \l{Rectangle} items. You can change the fill and border colors and add
gradients.
\image qml-toolbar-rectangle.png "Qt Quick Toolbar for rectangles"
diff --git a/doc/src/widgets/qtdesigner-app-tutorial.qdoc b/doc/src/widgets/qtdesigner-app-tutorial.qdoc
index edabb72f5ec..06fcd438cf7 100644
--- a/doc/src/widgets/qtdesigner-app-tutorial.qdoc
+++ b/doc/src/widgets/qtdesigner-app-tutorial.qdoc
@@ -31,8 +31,7 @@
\title Creating a Qt Widget Based Application
This tutorial describes how to use \QC to create a small Qt application,
- Text Finder. It is a simplified version of the Qt UI Tools
- \l{http://qt-project.org/doc/qt-5.0/qtuitools/textfinder.html}{Text Finder
+ Text Finder. It is a simplified version of the Qt UI Tools \l{Text Finder
example}. The application user interface is constructed from Qt widgets by
using \QD. The application logic is written in C++ by using the code editor.
@@ -198,7 +197,7 @@
\endlist
For more information about designing forms with \QD, see the
- \l{http://qt-project.org/doc/qt-5.0/qtdesigner/qtdesigner-manual.html}{Qt Designer Manual}.
+ \l{Qt Designer Manual}.
\section2 Completing the Header File
@@ -232,8 +231,7 @@
\li Add code to load a text file using QFile, read it with QTextStream,
and then display it on \c{textEdit} with
- \l{http://qt-project.org/doc/qt-5.0/qtwidgets/qtextedit.html#plainText-prop}
- {setPlainText()}.
+ \l{QTextEdit::setPlainText()}.
This is illustrated by the following code snippet:
\snippet textfinder/textfinder.cpp 0
@@ -244,9 +242,7 @@
\snippet textfinder/textfinder.cpp 1
\li For the \c{on_findButton_clicked()} slot, add code to extract the
- search string and use the
- \l{http://qt-project.org/doc/qt-5.0/qtwidgets/qtextedit.html#find}{find()}
- function
+ search string and use the \l{QTextEdit::find()} function
to look for the search string within the text file. This is
illustrated by the following code snippet:
diff --git a/doc/src/widgets/qtdesigner-overview.qdoc b/doc/src/widgets/qtdesigner-overview.qdoc
index 2b6850bfc8a..6c558da4ed3 100644
--- a/doc/src/widgets/qtdesigner-overview.qdoc
+++ b/doc/src/widgets/qtdesigner-overview.qdoc
@@ -35,8 +35,7 @@
\image qtcreator-formedit.png
- For more information about \QD, see the
- \l{http://qt-project.org/doc/qt-5.0/qtdesigner/qtdesigner-manual.html}{Qt Designer Manual}.
+ For more information about \QD, see the \l{Qt Designer Manual}.
Generally, the integrated \QD contains the same functions as the standalone
\QD. The following sections describe the differences.
diff --git a/doc/src/widgets/qtdesigner-plugins.qdoc b/doc/src/widgets/qtdesigner-plugins.qdoc
index 58b160b6e71..b2934feabd4 100644
--- a/doc/src/widgets/qtdesigner-plugins.qdoc
+++ b/doc/src/widgets/qtdesigner-plugins.qdoc
@@ -41,8 +41,7 @@
and to change the default plugin path, see \l{How to Create Qt Plugins}.
For more information about how to create plugins for \QD, see
- \l{http://qt-project.org/doc/qt-5.0/qtdesigner/designer-using-custom-widgets.html}
- {Using Custom Widgets with Qt Designer}.
+ \l{Using Custom Widgets with Qt Designer}.
\section1 Locating Qt Designer Plugins
@@ -75,8 +74,7 @@
\QC uses its own set of Qt Libraries located in the bundle, and therefore,
you need to configure the \QD plugins that you want to use with \QC.
Fore more information about how to deploy applications to Mac OS, see
- \l{http://qt-project.org/doc/qt-5.0/qtdoc/deployment-mac.html}
- {Deploying an Application on Mac OS X}.
+ \l{Deploying an Application on Mac OS X}.
The following example illustrates how to configure version 5.2.1 of the
\l{http://qwt.sourceforge.net/}{Qwt - Qt Widgets for Technical Applications}
--
GitLab