Skip to content
GitLab

Source

Target

Commits (2)
Hide whitespace changes
Inline Side-by-side
Showing
with 67 additions and 71 deletions
doc/src/addons.qdoc
View file @ a9e2b45e
......@@ -40,70 +40,70 @@ platforms supported by Qt.
The following are the add-on modules available in the Qt SDK.
\section1 Qt ActiveQt Module
\section1 Active Qt Module
The \l {Qt ActiveQt} Module provides support for ActiveX and COM on Windows platforms.
The \l {Active Qt} module provides support for ActiveX and COM on Windows platforms.
\section1 Qt Concurrent Module
The \l {Qt Concurrent} Module provides APIs to make it simpler and safer to
\l{Concurrent Programming}{write multi-threaded code} in a structured manner, enabling your
The \l {Qt Concurrent} module provides APIs to make it simpler and safer to
write multi-threaded code in a structured manner, enabling your
application to better exploit the hardware resources of the platform where it is running.
\section1 Qt Declarative Module
The \l {Qt Declarative} Module provides APIs and tools to support code written in Qt Quick 1.
The \l {Qt Declarative} module provides APIs and tools to support code written in Qt Quick 1.
\section1 Qt Graphical Effects Module
The \l {Qt Graphical Effects} Module is an extension to QtQuick which provides a ready-made set
The \l {Qt Graphical Effects} module is an extension to \l{Qt Quick} which provides a ready-made set
of shader effects to be used in QML. The module provides graphical effects such as blurring,
colorization, drop shadows, and more.
\section1 Qt Image Formats Module
The \l {Qt Image Formats} Module contains plugins that provide support for an extended set of
The \l {Qt Image Formats} module contains plugins that provide support for an extended set of
image formats to Qt applications.
\section1 Qt OpenGL Module
The \l{Qt OpenGL} Module is primarily provided for compatibility with Qt 4. The essential
\l{Qt Gui} Module provides a set of OpenGL classes which cover most use cases where you want to
The \l{Qt OpenGL} module is primarily provided for compatibility with Qt 4. The essential
\l{Qt GUI} module provides a set of OpenGL classes which cover most use cases where you want to
mix Qt- and OpenGL-based code.
\section1 Qt Print Support Module
The \l {Qt Print Support} Module provides cross-platform APIs to make printing easy and portable.
The \l {Qt Print Support} module provides cross-platform APIs to make printing easy and portable.
Printing with Qt is done by using the same \l {QPainter} APIs which can also be used to
paint on screen or on a \l {QImage}.
\section1 Qt Script Module
The \l {Qt Script} Module provides APIs to
The \l {Qt Script} module provides APIs to
\l{Making Applications Scriptable}{make Qt applications scriptable}. This
module is primarily provided for compatibility with Qt 4, and to support applications that
use the \l {Qt Declarative} Module. An alternative API is provided by the essential
\l {Qt Qml} Module. For more information, see
\l{Scripting Classes and Overviews}{the list of QtScript APIs}, or
\l{Creating QtScript Extensions}{learn how to make your own extensions} to QtScript.
use the \l {Qt Declarative} module. An alternative API is provided by the essential
\l {Qt QML} module. For more information, see
\l{Scripting Classes and Overviews}{the list of Qt Script APIs}, or
\l{Creating Qt Script Extensions}{learn how to make your own extensions} to \l{Qt Script}.
\section1 Qt SVG Module
Scalable Vector Graphics, or "SVG", is an XML-based format for storing vector-based graphics.
The \l {Qt SVG} Module provides APIs to render and save files in the SVG format, and supports
The \l {Qt SVG} module provides APIs to render and save files in the SVG format, and supports
a subset of the SVG 1.2 Tiny standard.
\section1 Qt Tools Module
The \l {Qt Tools} Module provides APIs related to the specific tools provided to make development
with Qt easier. In particular there is the \l {Qt UI Tools} Module which provides classes to handle
the forms created in Qt Designer and the \l {Qt Help} Module which can be used to integrate online
The \l {Qt Tools} module provides APIs related to the specific tools provided to make development
with Qt easier. In particular there is the \l {Qt UI Tools} module which provides classes to handle
the forms created in Qt Designer and the \l {Qt Help} module which can be used to integrate online
documentation in applications, similar to Qt Assistant.
\section1 Qt XML Module
The \l {Qt XML} Module is provided for compatibility with older code. It has been superseded by
the QXmlStreamReader and QXmlStreamWriter classes in the \l {Qt Core} Module.
the QXmlStreamReader and QXmlStreamWriter classes in the \l {Qt Core} module.
For more information, read the section "XML Support in Qt" in the \l {Data Structure and Storage}
overview.
......
doc/src/bughowto.qdoc
View file @ a9e2b45e
......@@ -51,7 +51,7 @@
\li Reliable and clear description on how to reproduce the problem
\endlist
If possible, please provide a test written using the QtTest module
If possible, please provide a test written using the \l{Qt Test} module
as this will improve the procedure of reproducing your problem and
allow the developers to address the issue in a more efficient way.
......
doc/src/connectivity.qdoc
View file @ a9e2b45e
......@@ -47,8 +47,8 @@ can start or stop network interfaces and roam between access points. It does
however not take care of the network configurations itself. The platform needs
to take care of that.
Qt Webkit offers a web browser engine that makes it possible to use web
content in your application. Qt Webkit can render HTML, XHTML,
\l{Qt WebKit} offers a web browser engine that makes it possible to use web
content in your application. \l{Qt WebKit} can render HTML, XHTML,
and SVG documents, and execute Javascript.
Qt also offers functionalities for \e{inter-process communication} (IPC). The
......@@ -111,7 +111,7 @@ Qt makes it easy to embed web content into your Qt application using features of
the Qt WebKit layout engine. The Qt WebKit module equips Qt with support for a
broad range of standard web technologies that make it possible to embed HTML
content styled with CSS and scripted with JavaScript into your Qt application.
QtWebKit facilitates both integration with traditional QWidget based desktop
\l{Qt WebKit} facilitates both integration with traditional QWidget based desktop
applications as well as embedding into Qt Quick QML applications.
For more information see \l {Integrating Web Content}.
......@@ -156,12 +156,12 @@ Related Topics:
\list
\li \l {Qt D-Bus} - module documentation
\list
\li \l {Using QtDBus Adaptors}
\li \l {Using Qt D-Bus Adaptors}
\li \l {QLocalSocket}
\li \l {Declaring Signals in D-Bus Adaptors}
\li \l {Declaring Slots in D-Bus Adaptors}
\li \l {The QtDBus Type System}
\li \l {QtDBus XML Compiler (qdbusxml2cpp)}
\li \l {The Qt D-Bus Type System}
\li \l {Qt D-Bus XML Compiler (qdbusxml2cpp)}
\endlist
\endlist
......
doc/src/deployment/deployment.qdoc
View file @ a9e2b45e
......@@ -84,7 +84,7 @@
\li \l{Qt Quick}{QtQuick}
\row
\li \l{Qt Multimedia}{QtMultimedia}
\li \l{Qt WebKit}{QtWebkit}
\li \l{Qt WebKit}{QtWebKit}
\li \l{Qt WebKit Widgets}{QtWebKitWidgets}
\li \l{Qt XML}{QtXml}
\row
......@@ -148,7 +148,7 @@
\li The version of clucene distributed with Qt is licensed
under the GNU LGPL version 2.1 or later. This has implications for
developers of closed source applications. Please see
\l{QtHelp Module#License Information}{the QtHelp module documentation}
\l{Qt Help Module#License Information}{the Qt Help module documentation}
for more information.
\row \li \l{QtNetwork} \li OpenSSL
......@@ -160,7 +160,7 @@
\row \li \l{QtWebKit} \li WebKit
\li WebKit is licensed under the GNU LGPL version 2 or later.
This has implications for developers of closed source applications.
Please see \l{WebKit in Qt#License Information}{the QtWebKit module
Please see \l{WebKit in Qt#License Information}{the Qt WebKit module
documentation} for more information.
\endtable
......@@ -477,10 +477,6 @@
library folder and loaded on start-up. This can be used, for instance, to enable OpenSSL
in your application. Simply set the paths to the required \c{libssl.so} and \c{libcrypto.so}
libraries here and OpenSSL should be enabled automatically.
\li \c{QMAKE_SUPPORTED_ORIENTATIONS}: Used to set the supported orientation of your application.
You can set a single orientation to lock the orientation of the application, or you can leave
this blank to use the target's default. The supported values are: \e Portrait, \e Landscape,
\e InvertedLandscape and \e InvertedPortrait.
\endlist
\section1 Qt Creator
......
doc/src/development/cmake-manual.qdoc
View file @ a9e2b45e
......@@ -91,8 +91,8 @@
\snippet snippets/cmake/CMakeLists.pro 2
Plugins are also available as \c IMPORTED targets in CMake. The \l{QtNetwork}, \l{QtSql}, \l{QtGui}
and \l{QtWidgets} modules have plugins associated. They provide a list of plugins in the
Plugins are also available as \c IMPORTED targets in CMake. The \l{Qt Network}, \l{Qt SQL}, \l{Qt GUI}
and \l{Qt Widgets} modules have plugins associated. They provide a list of plugins in the
\l{Qt5}\e{<Module>}\c{_PLUGINS} variable.
\snippet snippets/cmake/CMakeLists.pro 7
......
doc/src/developmenttools.qdoc
View file @ a9e2b45e
......@@ -87,7 +87,7 @@
\li Generate C++ code from user interface files.
\row \li \l{Resource Compiler (rcc)}
\li Embed resources into Qt applications during the build process.
\row \li \l{QtDBus XML compiler (qdbusxml2cpp)}
\row \li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
\li A tool to convert D-Bus interface descriptions to C++ source code.
\row \li \l{D-Bus Viewer}
\li A tool to introspect D-Bus objects and messages. Available from
......
doc/src/frameworks-technologies/ipc.qdoc
View file @ a9e2b45e
......@@ -59,7 +59,7 @@
\l{signalsandslots.html} {Signals and Slots} mechanism to the IPC
level, allowing a signal emitted by one process to be connected to
a slot in another process. The \l{Qt D-Bus} documentation has detailed
information on how to use the \l{QtDBus} module.
information on how to use the \l{Qt D-Bus} module.
\section1 QProcess
......
doc/src/getting-started/examples.qdoc
View file @ a9e2b45e
......@@ -71,7 +71,7 @@
\omit
Omitted for now since the links are broken.
\section2 QtWebKit
\section2 Qt WebKit
\list
\li \l{QtWebKit Guide} - An introductory guide to the features of QtWebKit
and HTML5.
......@@ -116,7 +116,7 @@
tour through the translations process, explaining the tools provided for
developers, translators and release managers.
\omit broken links
\image linguist-examples.png QtLinguist
\image linguist-examples.png Qt Linguist
\endomit
\endlist
......@@ -314,7 +314,7 @@
\image xml-examples.png XML
The XQuery/XPath and XML Schema engines in the QtXmlPatterns modules
The XQuery/XPath and XML Schema engines in the \l{Qt XML Patterns} module
provide classes for querying XML files and custom data models.
\annotatedlist xmlpattern_examples
......
doc/src/getting-started/gettingstartedqt.qdoc
View file @ a9e2b45e
......@@ -31,7 +31,7 @@
\title Getting Started Programming with Qt Widgets
In this topic, we teach basic Qt knowledge by implementing a simple Notepad
application using C++ and the \l{QtWidgets Module}{Qt Widgets module}. We use the
application using C++ and the \l{Qt Widgets} module. We use the
Qt Creator IDE and Qt Designer to generate some code, but you could also write all the
code yourself.
......
doc/src/graphics.qdoc
View file @ a9e2b45e
......@@ -106,8 +106,8 @@ OpenGL into their applications.
\list
\li \l {qtgui-index.html#opengl-and-opengl-es-integration}{OpenGL
in QtGui} - An overview of how OpenGL integrates with the Qt GUI
Module.
in Qt GUI} - An overview of how OpenGL integrates with the \l{Qt GUI}
module.
\li \l {Mixing Scene Graph and OpenGL}{OpenGL and Qt Quick 2.0} -
How to integrate OpenGL into a the Qt Quick 2.0 scene graph.
......@@ -117,9 +117,9 @@ OpenGL into their applications.
\endlist
Prior to Qt 5.0, OpenGL support in Qt was handled by the \l {Qt OpenGL
Module}. This module is still present, but new code should aim to use
the new classes in the \l {Qt GUI Module}.
Prior to Qt 5.0, OpenGL support in Qt was handled by the \l {Qt OpenGL}
module. This module is still present, but new code should aim to use
the new classes in the \l {Qt GUI} module.
......
doc/src/howtos/restoring-geometry.qdoc
View file @ a9e2b45e
......@@ -44,7 +44,7 @@
decoration frame. Although X provides a way to avoid this shift,
some window managers fail to implement this feature.
When using QtWidgets, Qt provides functions that saves and restores a
When using \l{Qt Widgets}, Qt provides functions that saves and restores a
widget window's geometry and state for you. QWidget::saveGeometry()
saves the window geometry and maximized/fullscreen state, while
QWidget::restoreGeometry() restores it. The restore function also
......
doc/src/platforms/emb-opengl.qdocinc
View file @ a9e2b45e
......@@ -22,7 +22,7 @@ ES Shading Language (GLSL ES)}. Instead of using the pre-defined functions,
the programmer writes small shader programs telling the hardware in detail
how to render each object.
The \l {QtOpenGL module} offers classes that make it easy to draw 3D
The \l {Qt OpenGL} module offers classes that make it easy to draw 3D
graphics in GUI applications using OpenGL ES. Qt provides a plugin that
integrates both OpenGL ES versions \l
{http://www.khronos.org/opengles/1_X}{1.x} and \l
......
doc/src/platforms/linux.qdoc
View file @ a9e2b45e
......@@ -289,7 +289,7 @@
\section1 OpenGL Dependencies
The configure script will autodetect if OpenGL headers and libraries are
installed on your system, and if so, it will include the QtOpenGL module
installed on your system, and if so, it will include the \l{Qt OpenGL} module
in the Qt library.
If your OpenGL headers or libraries are placed in a non-standard directory,
......@@ -311,9 +311,9 @@
distributions; try searching for \c gstreamer or \c libgstreamer in your
distribution's package repository to find suitable packages.
\section1 QtWebKit Dependencies
\section1 WebKit Dependencies
QtWebKit depends on some extra development tools in addition to those required for the rest of Qt.
\l{Qt WebKit} depends on some extra development tools in addition to those required for the rest of Qt.
\note These dependencies are only needed if you use a source version of Qt.
They are not required when using a prebuilt library.
......@@ -330,7 +330,7 @@
These should be available in most major Linux distributions, but the exact install instructions will vary.
For the most up to date information about QtWebKit dependencies, please refer to the \l{http://trac.webkit.org/wiki/BuildingQtOnLinux}{QtWebKit wiki for Linux}
For the most up to date information about \l{Qt WebKit} dependencies, please refer to the \l{http://trac.webkit.org/wiki/BuildingQtOnLinux}{Qt WebKit wiki for Linux}
*/
......@@ -712,7 +712,7 @@
specific subdirectory (such as \c imageformats or \c sqldrivers)
within your distribution directory, as described below.
\note If you are deploying an application that uses QtWebKit to display
\note If you are deploying an application that uses \l{Qt WebKit} to display
HTML pages from the World Wide Web, you should include all text codec
plugins to support as many HTML encodings possible.
......@@ -795,7 +795,7 @@
mode.
\li Versions 10.1.008 to 10.1.015 for both IA-32 and Intel 64 are
known crash with "(0): internal error: 0_47021" when compiling
QtXmlPatterns, QtWebKit, and Designer in release mode. Version
\l{Qt XML Patterns}, \l{Qt WebKit}, and \l{Qt Designer} in release mode. Version
10.1.017 compiles these modules correctly in release mode.
\endlist
......
doc/src/platforms/macosx.qdoc
View file @ a9e2b45e
......@@ -1095,9 +1095,9 @@
\li Debug versions of the plugins are not deployed.
\li The designer plugins are not deployed.
\li The Image format plugins are always deployed.
\li SQL driver plugins are deployed if the application uses the QtSql module.
\li Script plugins are deployed if the application uses the QtScript module.
\li The svg icon plugin is deployed if the application uses the QtSvg module.
\li SQL driver plugins are deployed if the application uses the \l{Qt SQL} module.
\li Script plugins are deployed if the application uses the \l{Qt Script} module.
\li The svg icon plugin is deployed if the application uses the \l{Qt SVG} module.
\li The accessibility plugin is always deployed.
\endlist
......
doc/src/portingcppapps_toqt5.qdoc
View file @ a9e2b45e
......@@ -39,7 +39,7 @@ port the \l{Animated Tiles Example}{Animated Tiles} application to Qt 5:
\c {#include <QtWidgets>}.
\li Edit the \c {animatedtiles.pro} and add \c {QT += widgets} towards the
end of the file.
\note QtGui is included by default in all Qt applications unless excluded using the \c {QT -= gui} directive in the \c{qmake} project file.
\note \l{Qt GUI} is included by default in all Qt applications unless excluded using the \c {QT -= gui} directive in the \c{qmake} project file.
\li Save the changes and run the application.
\endlist
......
doc/src/portingguide.qdoc
View file @ a9e2b45e
......@@ -48,8 +48,8 @@ The following list summarizes the changes in Qt 5:
from the codebase.
\li Platform defines - All platform-specific code must be wrapped using the
preprocessor macro, \c{Q_OS_*} instead of \c{Q_WS_*}.
\li Qt Widgets - These are now part of a separate module,
\l{Qt Widgets}{QtWidgets}. They were part of \l{QtGui} earlier.
\li Widgets - These are now part of a separate module,
\l{Qt Widgets}. They were part of \l{Qt GUI} earlier.
\li Qt Quick - The older Qt Quick version (1.0) is now part of a separate
\l{http://qt-project.org/doc/qt-4.8/qtdeclarative.html}{Qt Declarative}
add-on module for compatibility purposes. We recommend using the new Qt
......
doc/src/portingqmlapp.qdoc
View file @ a9e2b45e
......@@ -48,7 +48,7 @@ application work to Qt 5:
\c{qml/common/RssModel.qml}.
\note \l{Qt Quick XmlListModel QML Types}{XmlListModel} is part of a
submodule under \l{QtQuick} and it must be imported explicitly in order
submodule under \c{QtQuick} and it must be imported explicitly in order
to use it.
\li Make the following changes to
......
doc/src/qtmodules.qdoc
View file @ a9e2b45e
......@@ -202,13 +202,13 @@
\li All
\li
\li Classes for making Qt applications scriptable. Provided for Qt 4.x
compatibility. Please use the QJS* classes in the QtQml module for
compatibility. Please use the QJS* classes in the \l{Qt QML} module for
new code.
\row
\li \l{Qt Script Tools}
\li All
\li
\li Additional components for applications that use Qt Script.
\li Additional components for applications that use \l{Qt Script}.
\row
\li \l{Qt Sensors}
\li All
......
doc/src/scripting.qdoc
View file @ a9e2b45e
......@@ -34,21 +34,21 @@ Qt has three main ways to help make an application scriptable. All of them allow
integration of the \l{ECMAScript Reference}{ECMAScript} (more widely known as JavaScript) language into the application. Depending on how deep
the integration should be, one of these APIs can be used:
\section1 QtScript
\l QtScript is a separate module, designed with scripting applications in mind. It has
\section1 Qt Script
\l {Qt Script} is a separate module, designed with scripting applications in mind. It has
a mature and rich API that permits a really deep integration of scripting functionality. It allows
evaluating and debugging of scripts, and advanced use of objects and functions. It also gives access to a really
low level \l{ECMAScript Reference}{ECMAScript} engine API. Full documentation about using QtScript to make an application
low level \l{ECMAScript Reference}{ECMAScript} engine API. Full documentation about using \l{Qt Script} to make an application
scriptable can be found \l{Making Applications Scriptable}{here}.
\section1 JS API
This is a simple API, very similar to QtScript, but limited to basic functionality. The main
This is a simple API, very similar to \l{Qt Script}, but limited to basic functionality. The main
classes are QJSEngine and QJSValue, which can be used to embed pure \l{ECMAScript Reference}{ECMAScript} functionality
like evaluating scripts and calling functions.
\section1 QML
\l{Qt QML}{QML} exposes a modified \l{ECMAScript Reference}{ECMAScript} environment. It is designed to mix well with the JavaScript
API mentioned earlier. QML may be used without QtQuick components, which may be useful for
API mentioned earlier. QML may be used without \l{Qt Quick} components, which may be useful for
server side scripting. With QML it is possible to mix pure \l{ECMAScript Reference}{ECMAScript} and declarative components
(\l{Use Case - Integrating JavaScript in QML}).
......
doc/src/source-breaks.qdoc
View file @ a9e2b45e
......@@ -57,7 +57,7 @@ The following sections lists the API changes in each module and provides recomme
\li \c{QMetaType::unregisterType()} is removed.
\li \l{QMetaType} now records whether the type argument inherits QObject.
Such information can be useful for scripting APIs, so that custom QObject subclasses
are treated as QObject pointers. For example, in QtScript this
are treated as QObject pointers. For example, in \l{Qt Script} this
means \l{QScriptValue.isQObject} can be true, where it was false before.
\li \c{QMetaType::QWidgetStar} is removed. Use \l{qMetaTypeId<QWidget*>()}
or \l{QVariant::canConvert<QWidget*>()} instead.
......@@ -292,7 +292,7 @@ The following sections lists the API changes in each module and provides recomme
\code
#include <QtWebKitWidgets/QtWebKitWidgets>
\endcode
\li A consequence of the module split is that classes of the QtWebKit API aren't all in the new module, so for a better
\li A consequence of the module split is that classes of the \l{Qt WebKit} API aren't all in the new module, so for a better
compatibility of your application with both Qt4 and Qt5, #include <QtWebKit/QWebPage>, for example, should be included
directly as:
\code
......