summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPasi Petäjäjärvi <pasi.petajajarvi@theqtcompany.com>2015-08-26 10:16:31 +0300
committerPasi Petäjäjärvi <pasi.petajajarvi@theqtcompany.com>2015-08-26 10:16:37 +0300
commit09c8725e4755f15db9d3b112999a01ce2a958400 (patch)
tree0d0938757efcc9c95a7dcad9d85b849e7d3f68f0 /doc
parent872be20c2a4eaed372560f26779fe402a5192782 (diff)
parentee02a2d816f85d2bf91781e50d3ed1cb54aae3e0 (diff)
downloadqtdoc-09c8725e4755f15db9d3b112999a01ce2a958400.tar.gz
Merge branch '5.5' into vxworks-5.5
* 5.5: Document issues with Touch Screen Input and Weston Fix grammar in supported platforms docs. Add the GPLv3 license text Fix reference to non-existent JavaScript documentation. iOS: Fix launch image code sample and explanation Doc: remove Xcode and OS X version for iOS development Add missing options to the uic documentation Doc: replace Mac OS X with OS X Doc: cmake-manual: Update module variables Bump version Remove BlackBerry related documentation. List The Qt Company as owner of Qt trademarks Licensing: Replace Digia by The Qt Company Doc: iOS platform notes: Fix missing \endcode command Add mention of BSD license code used in QImage::transformed Doc: Fix class name mentioned in licensing documentation Change-Id: I3a48df2200c0dce7ec65076e1a64eefd233c6de6
Diffstat (limited to 'doc')
-rw-r--r--doc/src/configure.qdoc2
-rw-r--r--doc/src/datastorage.qdoc2
-rw-r--r--doc/src/development/cmake-manual.qdoc10
-rw-r--r--doc/src/development/uic.qdoc5
-rw-r--r--doc/src/external-resources.qdoc22
-rw-r--r--doc/src/howtos/scalabilityintro.qdoc6
-rw-r--r--doc/src/legal/licenses.qdoc14
-rw-r--r--doc/src/legal/opensourcelicense.qdoc2
-rw-r--r--doc/src/legal/trademarks.qdoc7
-rw-r--r--doc/src/mobile.qdoc1
-rw-r--r--doc/src/platforms/blackberry.qdoc514
-rw-r--r--doc/src/platforms/emb-linux.qdoc5
-rw-r--r--doc/src/platforms/ios.qdoc13
-rw-r--r--doc/src/platforms/platform-notes-blackberry.qdoc158
-rw-r--r--doc/src/platforms/platform-notes-rtos.qdoc7
-rw-r--r--doc/src/platforms/supported-platforms.qdoc4
-rw-r--r--doc/src/qmlapp/usecases/integratingjs.qdoc2
-rw-r--r--doc/src/qt5-intro.qdoc3
-rw-r--r--doc/src/qtmodules.qdoc6
19 files changed, 46 insertions, 737 deletions
diff --git a/doc/src/configure.qdoc b/doc/src/configure.qdoc
index 98a5d0c7..79184d57 100644
--- a/doc/src/configure.qdoc
+++ b/doc/src/configure.qdoc
@@ -237,8 +237,6 @@
\li \l{Building Qt 5 for Android} Wiki page
\li \l{Qt for iOS - Building from Source}
\li \l{Qt for WinRT#Building from source}{Qt for WinRT - Building from Source}
- \li \l{Qt for BlackBerry} - a community-driven site for BlackBerry and
- QNX devices
\li \l{Qt for Embedded Linux#Configuring for a Specific Device}{Qt for Embedded Linux - Building from Source}
\li \l{http://wiki.qt.io/Qt_RaspberryPi}{Qt for Raspberry Pi} - a community-driven site for
Raspberry devices
diff --git a/doc/src/datastorage.qdoc b/doc/src/datastorage.qdoc
index 2906a4db..d887af1b 100644
--- a/doc/src/datastorage.qdoc
+++ b/doc/src/datastorage.qdoc
@@ -236,7 +236,7 @@ The QSettings class provides persistent storage of application settings.
An application usually remembers its settings from the previous session.
Settings are stored differently on different platforms. For example,
-on Windows they are stored in the registry, whereas, on MAC OS X they are
+on Windows they are stored in the registry, whereas, on OS X they are
stored in XML files.
QSettings enable you to save and restore application settings in a portable
diff --git a/doc/src/development/cmake-manual.qdoc b/doc/src/development/cmake-manual.qdoc
index 08e482e0..f2d69509 100644
--- a/doc/src/development/cmake-manual.qdoc
+++ b/doc/src/development/cmake-manual.qdoc
@@ -143,10 +143,12 @@
\c{find_package}(Qt5Widgets) will make the following variables available if successfully found:
\list
- \li Qt5Widgets_VERSION_STRING
- \li Qt5Widgets_LIBRARIES List of libraries for use with the target_link_libraries command, for example.
- \li Qt5Widgets_INCLUDE_DIRS List of libraries for use with the include_directories command, for example.
- \li Qt5Widgets_DEFINITIONS List of definitions for use with add_definitions, for example.
+ \li Qt5Widgets_VERSION String describing the version of the module.
+ \li Qt5Widgets_VERSION_STRING Same as Qt5Widgets_VERSION.
+ Deprecated, use Qt5Widgets_VERSION instead.
+ \li Qt5Widgets_LIBRARIES List of libraries for use with the target_link_libraries command.
+ \li Qt5Widgets_INCLUDE_DIRS List of directories for use with the include_directories command.
+ \li Qt5Widgets_DEFINITIONS List of definitions for use with add_definitions.
\li Qt5Widgets_COMPILE_DEFINITIONS List of definitions for use with the COMPILE_DEFINITIONS target property.
\li Qt5Widgets_FOUND Boolean describing whether the module was found successfully.
\li Qt5Widgets_EXECUTABLE_COMPILE_FLAGS String of flags to be used when building executables.
diff --git a/doc/src/development/uic.qdoc b/doc/src/development/uic.qdoc
index a0eaafd7..e3e5772b 100644
--- a/doc/src/development/uic.qdoc
+++ b/doc/src/development/uic.qdoc
@@ -53,6 +53,11 @@
\row \li \c{-p} \li Don't generate guards against multiple inclusion (\c #ifndef FOO_H ...).
\row \li \c{-h} \li Display the usage and the list of options.
\row \li \c{-v} \li Display \c{uic}'s version number.
+ \row \li \c{-d} \li Display the dependencies for the UI.
+ \row \li \c{-n} \li Don't generate any #include directives.
+ \row \li \c{--postfix <postfix>} \li Append \c <postfix> to all generated classnames.
+ \row \li \c{--include <file>} \li Add #include \c <file> to the output.
+
\endtable
\section1 Examples
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
index 3eff9122..9ac7854f 100644
--- a/doc/src/external-resources.qdoc
+++ b/doc/src/external-resources.qdoc
@@ -196,28 +196,6 @@
\externalpage http://wiki.qt.io/Qt5ForAndroidBuilding
\title Building Qt 5 for Android
*/
-/*!
- \externalpage http://wiki.qt.io/Qt5_Status_on_BlackBerry10
- \title BlackBerry supported modules
-*/
-/*!
- \externalpage http://wiki.qt.io/Qt_Creator_with_BlackBerry_10
- \title Using Qt Creator for BlackBerry 10 Development
-*/
-/*!
- \externalpage https://developer.blackberry.com/native/documentation/cascades/device_platform/data_access/file_system.html
- \title Working with the file system
-*/
-
-/*!
- \externalpage https://developer.blackberry.com/native/documentation/cascades/dev/bb10_devices/
- \title BlackBerry 10 device characteristics
-*/
-
-/*!
- \externalpage https://developer.blackberry.com/native/documentation/core/com.qnx.doc.native_sdk.devguide/topic/c_appfund_applifecycle.html
- \title BlackBerry 10 application lifecycle
-*/
/*!
\externalpage http://wiki.openssl.org/index.php/Compilation_and_Installation#Configure_Options
diff --git a/doc/src/howtos/scalabilityintro.qdoc b/doc/src/howtos/scalabilityintro.qdoc
index 5f91e144..8d8b99cb 100644
--- a/doc/src/howtos/scalabilityintro.qdoc
+++ b/doc/src/howtos/scalabilityintro.qdoc
@@ -53,7 +53,7 @@
\list
\li You want to deploy your application to more than one device
- platform, such as Android, BlackBerry, and iOS, or more than one
+ platform, such as Android and iOS, or more than one
device screen configuration.
\li Your want to be prepared for new devices that might appear on the
market after your initial deployment.
@@ -426,8 +426,8 @@
You can use the QQmlFileSelector to apply a QFileSelector to QML file
loading. This enables you to load altenative resources depending on the
platform on which the application is run. For example, you can use the
- \c +android and \c +blackberry file selectors to load different image files
- when run on Android and BlackBerry devices.
+ \c +android file selector to load different image files
+ when run on Android devices.
You can use file selectors together with singleton objects to access a
single instance of an object on a particular platform.
diff --git a/doc/src/legal/licenses.qdoc b/doc/src/legal/licenses.qdoc
index f8f288d7..02923007 100644
--- a/doc/src/legal/licenses.qdoc
+++ b/doc/src/legal/licenses.qdoc
@@ -95,8 +95,8 @@
\row \li {1,30} Qt Core
- \row \li \l{QCrashHandler class}{QCrashHandler}
- \li Parts of implementation of QCrashHandler class. \li BSD-style \li
+ \row \li \l{QSegfaultHandler Class}{QSegfaultHandler}
+ \li Parts of implementation of QSegfaultHandler class. \li BSD-style \li
\row \li \l{QUrl::fromUserInput}{QUrl} \li Implementation of QUrl::fromUserInput(). \li Modified BSD \li
\row \li \l{Contributions to the Cocoa Platform Plugin Files}{Cocoa Platform Plugin}
\li Specific parts of the Qt for OS X Cocoa port. \li BSD-style \li \l{Qt for OS X}
@@ -157,6 +157,8 @@
\row \li {1,12} Qt Gui
\row \li \l{QKeyMapper class on X11 platforms}{QKeyMapper}
\li Internal class for key mapping. \li Custom, BSD-style \li \l {Qt for Linux/X11}
+ \row \li \l{qimage-legalese}{QImage}
+ \li Code used for smooth scaling in QImage::transformed(). \li BSD \li
\row \li {4,1} \b{Third-party Licenses}
\row \li \l{Other Licenses Used in Qt#FreeType}{FreeType}
@@ -173,7 +175,6 @@
\row \li \l{ANGLE (angle)}{ANGLE}
\li Opensource project to map OpenGL ES API calls to DirectX API. \li BSD-style \li \l {Qt for Windows}
\row \li \li \li \li
- \row \li \li \li \li
\row \li {1,4} Qt Location
@@ -367,7 +368,7 @@
This page lists the licenses used, names the authors, and links
to the places where it is used.
- Digia gratefully acknowledges these and other contributions
+ The Qt Company gratefully acknowledges these and other contributions
to Qt. We recommend that programs that use Qt also acknowledge
these contributions, and quote these license statements in an
appendix to the documentation.
@@ -396,7 +397,7 @@
\li \c {src/3rdparty/android/extract.h}
\endlist
- \section1 QCrashHandler class
+ \section1 QSegfaultHandler Class
Copyright (c) 1998 by Bjorn Reese <breese@imada.ou.dk>
@@ -410,7 +411,8 @@
CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
\list
- \li Parts of the QCrashHandler class
+ \li Parts of the QSegfaultHandler class in
+ \c {qtbase/src/corelib/kernel/qcrashhandler.cpp}.
\endlist
\section1 FreeType
diff --git a/doc/src/legal/opensourcelicense.qdoc b/doc/src/legal/opensourcelicense.qdoc
index 5d7e736e..a3299c6e 100644
--- a/doc/src/legal/opensourcelicense.qdoc
+++ b/doc/src/legal/opensourcelicense.qdoc
@@ -39,7 +39,7 @@
money. The Free Software Foundation, the creator of the GNU GPL, speaks
of free in this context as in "free speech", not as in "no cost".
- Digia supports the free software concept by providing the Qt Open Source
+ The Qt Company supports the free software concept by providing the Qt Open Source
Edition, which is licensed under the \l{GNU Lesser General Public License (LGPL)}
version 3 and the GNU LGPL version 2.1.
You can use this edition of Qt to create and distribute software with licenses
diff --git a/doc/src/legal/trademarks.qdoc b/doc/src/legal/trademarks.qdoc
index f3878ab6..593d6fd1 100644
--- a/doc/src/legal/trademarks.qdoc
+++ b/doc/src/legal/trademarks.qdoc
@@ -30,12 +30,13 @@
\title Trademarks
\ingroup licensing
- \brief Information about trademarks owned by Digia and other organisations.
+ \brief Information about trademarks owned by The Qt Company and other organizations.
- Digia, the Digia logo, Qt, and the Qt logo are trademarks of Digia Plc
- and/or its subsidiaries in Finland and other countries.
+ The Qt Company Ltd and/or its subsidiaries are the owner of Qt trademarks worldwide.
\list
+ \li Digia and the Digia logo are trademarks of Digia Plc and/or its subsidiaries
+ in Finland and other countries.
\li Intel, Intel Inside (logos), MMX and Pentium are \reg trademarks of
Intel Corporation in the United States, other countries, or both.
\li Oracle and Java are registered trademarks of Oracle and/or its affiliates.
diff --git a/doc/src/mobile.qdoc b/doc/src/mobile.qdoc
index e15ebc89..26cc79a3 100644
--- a/doc/src/mobile.qdoc
+++ b/doc/src/mobile.qdoc
@@ -41,7 +41,6 @@
\list
\li \l{Qt for Android}{Android}
\li \l{Qt for iOS}{iOS}
- \li \l{Qt for BlackBerry}{BlackBerry 10}
\endlist
\section1 Sensors
diff --git a/doc/src/platforms/blackberry.qdoc b/doc/src/platforms/blackberry.qdoc
deleted file mode 100644
index 53a1d86c..00000000
--- a/doc/src/platforms/blackberry.qdoc
+++ /dev/null
@@ -1,514 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2014 BlackBerry Limited. All rights reserved.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see http://www.qt.io/terms-conditions. For further
-** information use the contact form at http://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page blackberry_support.html
- \title Qt for BlackBerry 10
- \brief Provides information about BlackBerry support in Qt.
-
- Qt for BlackBerry allows to run Qt 5 applications on devices with BlackBerry
- 10 or later. BlackBerry 10 uses QNX as base OS, so Qt on BlackBerry 10 and Qt
- on QNX share the same code base.
-
- Development of Qt applications for the BlackBerry 10 platform is possible using
- the BlackBerry Native Development Kit. It contains the Momentics IDE along with
- a cross compiler toolchain and packaging and deployment tools.
- After setup you can opt for development with Qt Creator, command line tools or the
- Momentics IDE.
-
- The following topics provide more details about how to use Qt for BlackBerry:
- \list
- \li \l{Getting Started with Qt for BlackBerry 10}{Getting Started}
- \li \l{Qt 5 on BlackBerry 10}
- \li \l{Building Qt 5 for BlackBerry 10}
- \li \l{Deployment on BlackBerry 10}
- \li \l{Platform and Compiler Notes - BlackBerry}{Platform Notes}
- \endlist
-*/
-
-/*!
- \page blackberrygs.html
- \title Getting Started with Qt for BlackBerry 10
- \brief Provides instructions to install and configure your development environment.
-
- \section1 Development with Qt for BlackBerry 10
- Development of Qt applications for the BlackBerry 10 platform is possible using the
- \l{https://developer.blackberry.com/native/}{BlackBerry Native Development Kit}.
- First versions of NDK contained both, the Momentics IDE as well as the NDK itself.
- In recent releases, developers have to download the
- \l{https://developer.blackberry.com/native/downloads/}{Momentics IDE}
- first, which then installs the NDK and simulator packages. Every NDK package includes
- a cross compiler toolchain, plus packaging and deployment tools, basically all you
- need for development.
-
- \section1 Initial Preparation
- \section2 Get a BlackBerry ID
-
- The BlackBerry ID is used as an identity reference and is necessary to register as a
- developer and use the device in developer mode. You can
- \l{https://blackberryid.blackberry.com}{create a BlackBerry ID online}.
- If you already use a BlackBerry device, you should have a BlackBerry ID, as well. It is
- the same ID used in BBM or to download apps from BlackBerry World. If you have such
- an ID you can use it to get a BlackBerry ID token for development.
-
- \section2 Get the Momentics IDE
-
- First
- \l{https://developer.blackberry.com/native/downloads/}{download the Momentics IDE},
- set it up and download an NDK with appropriate API level, see this
- \l{https://developer.blackberry.com/native/documentation/cascades/getting_started/setting_up.html}
- {article}
- for more details.
-
- \section1 Setup
-
- \section2 Enable the Development Mode on the Device
- Make sure your device is connected to your computer.
- Switch on \b{Development Mode} in \e{Settings -> Security and Privacy ->
- Development Mode}.
-
- \section2 Install Momentics
-
- Install the Momentics IDE by executing
- \badcode
- cd ~/Downloads/
- chmod +x momentics-<your-version>.bin
- ./momentics-<your-version>.bin
- \endcode
-
- Install the suggested API level. Other API levels can be added
- \l{http://developer.blackberry.com/native/documentation/core/com.qnx.doc.ide.userguide/topic/update_ndk_ide.html}
- {later}.
- Select \e{Manage Devices} from the \e{Devices} drop-down menu. Create and Download the
- BlackBerry ID token needed for deployment and testing. Enter your company name and choose a
- password. Log in with your Black Berry ID and password in the pop-up window. Click \e{Next}
- and \e{Finish} to generate a debug token and deploy it to your device.
-
- Qt Creator 3.0 and later support the BlackBerry ID token and debug token management as well.
-
- \section1 Verify Your Setup with a Sample App
- \section2 In the Momentics IDE
- Select a sample application in the Momentics IDE and click Download and Import. This will
- download the sample and create a new project. Hit the green play button in Momentics to
- run the application on your BlackBerry 10 device. The application will now start on your
- BlackBerry 10 device.
-
- \section2 In Qt Creator
- See the
- \l{http://wiki.qt.io/Qt_Creator_with_BlackBerry_10}{article}
- Qt Creator with BlackBerry 10. Qt Creator 2.7 and later contain a plug-in which integrates
- the BlackBerry 10 NDK and its tools into the development process as it is know to Qt
- Creator users.
-
- \section1 Simulator
- You can download the Simulator from the Momentics IDE via the \gui{Devices} menu. Select
- \gui{Manage devices} from the main toolbar in Momentics and switch to the Simulator tab.
- The Simulator is available as separate download. For more details, see the this
- \l{https://developer.blackberry.com/devzone/develop/simulator/}{article}
- on the developer page. Installing the Simulator is optional. You most probably will test
- and deploy applications on a BlackBerry 10 device directly, but sometimes using the Simulator
- is more convenient. It also allows testing of your app on a configuration of a device which
- you do not have.
-
- If you work on the command line and use Qt 5.2 or later you have change the CPUVARDIR
- environment variable to switch to Simulator as target:
- \badcode
- export CPUVARDIR=x86
- \endcode
-
- Going back to the device target:
- \badcode
- export CPUVARDIR=armle-v7
- \endcode
-
- Certainly you have to re-run qmake each time you change CPUVARDIR.
-
- Note: You need to have VMware Player installed on your machine to run BlackBerry 10 Simulator.
-*/
-
-/*!
- \page blackberryqt5.html
- \title Qt 5 on BlackBerry 10
- \brief Provides instructions how to use Qt 5 on BlackBerry.
-
- Currently, Qt 5 is neither included in the BlackBerry 10 device software nor in the
- BlackBerry 10 SDK. Nevertheless, Qt 5 on BlackBerry 10 can be used for developing
- and publishing applications to BlackBerry World.
-
- There are currently two options how you can use Qt 5 on BlackBerry 10:
- \list
- \li Use a binary overlay to add Qt 5 to an NDK installation
- \li Make and use a custom Qt 5 build
- \endlist
-
- See sections below for more details.
-
- \section1 Using a Binary Overlay to Add Qt 5 to an NDK Installation
- Pre-built Qt 5 for BlackBerry is provided as a Qt Project delivery. The packages are available
- \l{http://qtlab.blackberry.com/downloads/ndk_10.2.0_overlay/qt521_20140317/}
- {here}.
- The overlay gives you a prebuilt and tested package and saves the time for building
- Qt 5 from scratch.
-
- Please go through the README to learn how to install and use the packages. The provided
- packages require the 10.2 Gold version of the BlackBerry 10 Native SDK. After the
- installation, Qt 5 is automatically recognized and configured in Qt Creator 3.0 (and later)
- and can be immediately used for application development.
- Even though you do not need an own build, you still need to pay attention to a few details
- described on this page.
-
- Note: The overlay packages are not a part of the official NDK distributions by BlackBerry,
- but as an add-on provided by the Qt Project. Be aware that you cannot mix Qt 5 code with
- Cascades application framework APIs based on Qt 4.8. The Momentics IDE currently does not
- support Qt 5 development.
-
- \section1 Make Custom Qt 5 Builds
-
- \list
- \li Please make sure your working environment is set up:
- \l{Getting Started with Qt for BlackBerry 10}{Setup for BlackBerry 10 development}
- \li Build Qt 5 for BlackBerry 10: \l{Building Qt 5 for Blackberry 10}
- \endlist
-*/
-
-/*!
- \page blackberrybuild.html
- \title Building Qt 5 for BlackBerry 10
- \brief Provides instructions how to build Qt 5 for BlackBerry.
-
- \section1 Setting up the Environment
-
- See \l{Getting Started with Qt for BlackBerry 10}{Setup for BlackBerry 10 development}
- for the introduction and further instructions.
-
- \section1 Getting the Source
-
- The approach we will take is to do an in-source build of the Qt 5 repositories that are
- needed but to install them to a custom directory (\e{$HOME/development/qnx/qt5} in the
- following example). Please also note that we clone and build git submodules separately.
- This procedure is different to the builds for desktop platforms and allows to include
- only those submodules which are relevant. Please adjust the paths to suit your setup as
- needed.
-
- First create a directory to hold the source code:
- \badcode
- cd $HOME/development
- mkdir qt5
- cd qt5
- \endcode
-
- The following repositories are used in regular builds for BlackBerry 10 in
- \l{http://qtlab.blackberry.com/}{BlackBerry’s public CI}:
- \list
- \li qtbase
- \li qtxmlpatterns
- \li qtsensors
- \li qtdeclarative
- \li qtmultimedia
- \li qtgraphicaleffects
- \li qtconnectivity
- \li qtquickcontrols
- \endlist
-
- This matches all essential modules, plus several add-on modules. QtWebKit is currently not
- a part of the regular builds. Still, it is possible to build it, see
- \l{http://wiki.qt.io/Building_QtWebKit_for_Blackberry}
- {Building QtWebKit for Blackberry}
-
- Other repositories known to build:
- \list
- \li qt3d (optional, provides 3D scenes using QML)
- \li qtscript (optional, only needed when using the qtquick1 submodule)
- \li qtlocation
- \endlist
-
- Then clone:
- \badcode
- git clone git://gitorious.org/qt/qtbase.git
- git clone git://gitorious.org/qt/qtxmlpatterns.git
- git clone git://gitorious.org/qt/qtsensors.git
- git clone git://gitorious.org/qt/qtdeclarative.git
- git clone git://gitorious.org/qt/qtmultimedia.git
- git clone git://gitorious.org/qt/qtgraphicaleffects.git
- git clone git://gitorious.org/qt/qtconnectivity.git
- git clone git://gitorious.org/qt/qtquickcontrols.git
- \endcode
-
- \section1 Building qtbase
-
- The process of building Qt 5 for BlackBerry devices is very similar to building it for any
- other platform so it is worth having a quick read through the generic instructions for
- building Qt 5 before proceeding.
-
- Be sure that you have configured your environment to use the BlackBerry 10 NDK
- (source the bbndk script on Linux for instance). This especially concerns setting
- the right values in $PATH to pickup tools and the cross-compile tool-chain
- provided in the NDK.
-
- \section2 Linux and OS X
-
- First we need to configure Qt.
-
- The examples below show a minimal set of configure options. You can see the full set of
- configure options used in the \l{http://qtlab.blackberry.com/}{BlackBerry’s public CI}
- in the raw console output of the \c qtbase build.
- See this \l{http://qtlab.blackberry.com/job/qt-5-qtbase-stable/}{link} and then open the
- raw \e{Console Output} for the last successful build for ARM or for x86.
- \badcode
- cd qtbase
- ./configure -prefix $HOME/development/qnx/qt5 -xplatform blackberry-armle-v7-qcc -opengl es2 -nomake examples -nomake tests -opensource -confirm-license -release
- \endcode
-
- Afterwards we simply build it by calling make and make install.
- \badcode
- make -j<N>
- make install
- \endcode
-
- where \c{<N>} is the number of parallel make jobs to run. This is often set to \c{<No. of CPU cores + 1>}.
-
- \section2 Windows
- \badcode
- C:\dev> cd qtbase
- C:\dev\qtbase> configure -prefix C:\dev\qt5install -xplatform blackberry-armle-v7-qcc -opengl es2 -nomake examples -nomake tests -opensource -confirm-license -release
- \endcode
-
- If you want to work with the HTTPS protocol, add the \c{-openssl} option.
-
- \section2 OS X
-
- This is almost the same as on Linux:
- \badcode
- $ cd qtbase
- $ ./configure -prefix $HOME/development/qnx/qt5 -xplatform blackberry-armle-v7-qcc -opengl es2 -nomake examples -nomake tests -opensource -confirm-license -release -no-neon
- \endcode
-
- After this process, you should have a basic Qt 5 installation located in \c{$HOME/development/qnx/qt5}
- or in \c{C:\dev\qt5install}, depending on your operating system.
-
- You may now either move on to building your applications or continue here to install
- some additional git submodules to gain access to additional features of Qt 5.
-
- \section1 Building Other Modules
-
- If you want to build additional git submodules, make sure to do this in the right order,
- because some git submodules depend on each other.
-
- To build additional git submodules we need to use the qmake from our new Qt 5 installation
- so we adjust the PATH environment variable accordingly:
-
- \b{Linux and OS X}: \c{export PATH=$HOME/development/qnx/qt5/bin:$PATH}
-
- \b Windows: \c{C:\dev> set PATH=C:\dev\qt5install\bin;%PATH%}
-
- Now for each of the additional git submodules that you wish to build, do the following:
-
- \section2 Linux and OS X
- \badcode
- cd <sub_module_name>
- qmake
- make -j<N>
- make install
- \endcode
-
- \section2 Windows
- \badcode
- C:\dev> cd <sub_module_name>
- C:\dev\submodule> qmake
- C:\dev\submodule> mingw32-make -j
- C:\dev\submodule> mingw32-make -j install
- \endcode
-*/
-
-/*!
- \page blackberryappdeploy.html
- \title Deployment on BlackBerry 10
- \brief Provides instructions how and deploy applications on BlackBerry.
-
- Generally, this topic is well explained in the BlackBerry 10 documentation for native
- application development.
-
- \section1 Application Packaging
- The page
- \l{https://developer.blackberry.com/native/documentation/core/qt_package_deploy.html}
- {Packaging, deployment and distribution}
- is a good introduction to the tools and how to use them. In short, applications are packaged
- in so called BAR files which are zip archives that contain additional meta-information.
-
- \section1 Blackberry Application aRchive (BAR) Descriptor File
- A part of this meta information is the content of the
- \l{https://developer.blackberry.com/native/documentation/core/com.qnx.doc.native_sdk.devguide/topic/c_about_bar_app_descriptor_file.html}
- {BAR application descriptor file}
- which is an XML file. This file describes the content of the package and where this content
- can be found. Other important meta-information is defined in this file, as well.
-
- Qt Creator has an editor for the BAR application descriptor files which simplifies quite
- some manual editing.
-
- The content of the package may also include images, sounds and any other data files used by
- the application in addition the the binary.
-
- See
- \l{https://developer.blackberry.com/native/documentation/core/com.qnx.doc.native_sdk.devguide/topic/r_blackberry_tablet_dtd_intro.html}
- {full list of all elements in a BAR application descriptor file}
-
- \section1 blackberry-nativepackager
- Application packages are created by the command line tool \b{blackberry-nativepackager}
- provided in the BlackBerry 10 NDK. This tool reads a BAR application descriptor file passed
- as an argument and builds the application package accordingly.
-
- Application packages can be built in development mode or can be built as signed packages.
- Development mode applications require a \b{debug token} and can be installed and run on any
- device with the same debug token as they were build with.
-
- Signed packaged are usually used for publishing in BlackBerry World. They can also be
- installed from the command line on any device in development mode and do not need a debug
- token.
-
- \section1 Where do the App Resources Land on the Device
-
- \section2 Handling the Sand Box
- Each application is installed in its own home folder on a dedicated partition. Shared folders
- (those which contain data to be shared between apps) are mapped according to permissions
- requested so that the app can access them under the standard paths. An important thing to
- keep in mind is that all applications can access files only within the boundaries of
- their \e sandboxes. When the app asks to access shared data, according folders become
- available in app’s sandbox as well. See
- \l{https://developer.blackberry.com/native/documentation/cascades/device_platform/data_access/file_system.html}
- {Working with the file system}
- for an overview of all sub-folders for different purposes in app’s home folder.
-
- Applications cannot directly access any files outside their sandboxes. Even though it is
- possible to package and deploy libraries with the application, it is not possible to deploy
- any libraries into the system folders. Applications cannot share their libraries with other
- applications either.
-
- \section2 Packaging and Accessing the Files
- Even though the article
- \l{https://developer.blackberry.com/native/documentation/cascades/device_platform/data_access/file_system.html}
- {Working with the file system}
- explains how the sandbox model influences file access, it might not be clear from the
- beginning how paths can actually be referred in the application code.
-
- This line is the universal way to add any other content to the app package:
- \badcode
- <asset path="<local_path_to_files>/<local_file_name>"><on_device_path_to_files>/<on_device_file_name></asset>
- \endcode
-
- or even shorter:
- \badcode
- <asset path="<SOURCE>"><TARGET></asset>
- \endcode
-
- Lets assume you have an app which loads an image with Qt Quick . The application code is
- located in the subfolder \e test_assets in your \e projects folder. The following line
- adds this image to the BAR application descriptor file:
- \badcode
- <asset path="/Users/johndoe/projects/test_assets/qt-logo.png">qt-logo.png</asset>
- \endcode
-
- You also have to add QML files:
- \badcode
- <asset path="/Users/johndoe/projects/test_assets/qml">qml</asset>
- \endcode
-
- Note that we used absolute paths in the above examples, though relative paths
- work, as well.
-
- The key thing to know here is that the app installation folder is mapped to the folder
- \e app/native in the application working directory (referred by QDir::currentPath(),
- for example a \c . folder in the BAR application descriptor file maps to the \e{app/native/}.
- folder. Our app would be installed for example in:
- \badcode
- /accounts/1000/appdata/com.example.test_assets.testDev_test_assetscd80795f
- \endcode
-
- The \e qt-logo.png lands here:
- \badcode
- /accounts/1000/appdata/com.example.test_assets.testDev_test_assetscd80795f/app/native/qt-logo.png
- \endcode
-
- The \e qml folder will be recursively copied to
- \badcode
- /accounts/1000/appdata/com.example.test_assets.testDev_test_assetscd80795f/app/native/qml/
- \endcode
-
- Our app has only one QML file which lands here:
- \badcode
- /accounts/1000/appdata/com.example.test_assets.testDev_test_assetscd80795f/app/native/qml/main.qml
- \endcode
-
- This QML code loads the image in \e main.qml as:
- \code
- Image {
- source: "../qt-logo.png"
- anchors.centerIn: parent
- }
- \endcode
-
- Notice the \c ../ in the front of the file name. This is because the current folder of a Qt
- Quick element is where its file was loaded from. We load \e main.qml this way:
- \code
- int main(int argc, char *argv[])
- {
- QGuiApplication app(argc, argv);
- QQmlApplicationEngine engine;
- engine.load(QUrl(QStringLiteral("app/native/qml/main.qml")));
- return app.exec();
- }
- \endcode
-
- \c Image assumes it is located in \c{app/native/qml/} and so needs to get one level up to get
- to \c app/native/qt-logo.png.
-
- One more thing to notice: the article
- \l{https://developer.blackberry.com/native/documentation/cascades/device_platform/data_access/file_system.html}
- {Working with the file system}
- also talks about a dedicated \e{assets directory}. This is a bit confusing, since the \e asset
- XML element in the BAR application descriptor file can refer to any file, but the
- \e assets directory refers to the asset URI scheme in the Cascades framework.
- Using Cascades UI components you can load image as:
- \code
- ImageView {
- imageSource: "asset:///image.png"
- }
- \endcode
-
- \section2 Prefer Using the Qt Resources
- Using Qt resources (via the \c{qrc://} scheme) for all small read-only files and especially
- for QML code files is a more preferred and convenient way! Accessing assets as files makes
- only sense for large read-only files or files which will be changed/created by the app.
-
- \section2 Viewing the Folders on the Device
- In some cases, it might be needed to inspect the actual content of the folders directly on
- the device. You can do this in an SSH shell in the File Inspector in the Momentics IDE.
- The article
- \l{http://wiki.qt.io/BlackBerry_Hints_n_Tips}{BlackBerry Hints and Tips}
- shows how to use SSH with BlackBerry 10 along with
- a few other hints and tips.
-
-*/
diff --git a/doc/src/platforms/emb-linux.qdoc b/doc/src/platforms/emb-linux.qdoc
index ae4a7750..0dee782d 100644
--- a/doc/src/platforms/emb-linux.qdoc
+++ b/doc/src/platforms/emb-linux.qdoc
@@ -568,4 +568,9 @@
The Qt Wayland module provides a \c wayland platform plugin that allows Qt
application to connect to a Wayland compositor.
+
+ \note Please note that you may experience issues with touch screen input with
+ the \l{http://wayland.freedesktop.org/}{Weston} reference compositor. Please
+ refer to the \l{https://wiki.qt.io/WestonTouchScreenIssues}{Qt Wiki} for
+ further information.
*/
diff --git a/doc/src/platforms/ios.qdoc b/doc/src/platforms/ios.qdoc
index 87223104..4cbcc431 100644
--- a/doc/src/platforms/ios.qdoc
+++ b/doc/src/platforms/ios.qdoc
@@ -61,9 +61,9 @@
Xcode. You will find it in the Mac App Store \l{Xcode}{here}.
\note As \l{Xcode5Req}{required by Apple}, you should always use the latest
- Xcode 5 version when building your applications for the App Store.
- In practice this means you need OS X 10.8 or 10.9 to do iOS development
- with Qt, as those are the only platforms where Xcode 5 will run.
+ Xcode version when building your applications for the App Store.
+ In practice this means you also need the latest version of OS X to develop
+ iOS apps with Qt, due to Xcode's system requirements.
For running Qt applications in the simulator that comes with Xcode,
this is all you need. However, for running applications on a
@@ -527,7 +527,7 @@
\badcode
<key>UILaunchImageFile</key>
<string>LaunchImage</string>
- \badcode
+ \endcode
The name defaults to \c Default, but qmake generates some of the images, so it is easier to use another name (for example LaunchImage as we did) to avoid clashes.
\list
\li LaunchImage.png: 320 x 480
@@ -545,12 +545,13 @@
like the following code snippet to the .pro file:
\badcode
ios {
- launch_images.files = $$PWD/ios/Launch.xib $$files($$PWD/ios/LaunchImage*.png)
- QMAKE_BUNDLE_DATA += launch_images
+ app_launch_images.files = $$PWD/ios/Launch.xib $$files($$PWD/ios/LaunchImage*.png)
+ QMAKE_BUNDLE_DATA += app_launch_images
}
\endcode
This allows you to produce universal applications with valid LaunchImages as required by the Apple App Store.
+ \important \c "launch_images" is used internally by Qt, so it will be overwritten if used in your .pro file.
\section1 Publishing to Apple App Store
diff --git a/doc/src/platforms/platform-notes-blackberry.qdoc b/doc/src/platforms/platform-notes-blackberry.qdoc
deleted file mode 100644
index 9a673e37..00000000
--- a/doc/src/platforms/platform-notes-blackberry.qdoc
+++ /dev/null
@@ -1,158 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2014 BlackBerry Limited. All rights reserved.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:FDL$
-** Commercial License Usage
-** Licensees holding valid commercial Qt licenses may use this file in
-** accordance with the commercial license agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see http://www.qt.io/terms-conditions. For further
-** information use the contact form at http://www.qt.io/contact-us.
-**
-** GNU Free Documentation License Usage
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of
-** this file. Please review the following information to ensure
-** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
- \page platform-notes-blackberry.html
- \title Platform and Compiler Notes - BlackBerry
- \contentspage Platform and Compiler Notes
-
- This page lists features and restrictions that are particular for Qt on BlackBerry 10.
-
- \section1 Supported Modules
-
- Most Qt modules (essential and add-on) are supported except for instance Qt WebKit and
- platform-specific ones. \l{BlackBerry supported modules} shows a detailed list of what
- is supported and what isn't.
-
- \section1 Application Window
-
- The first top-level window that is shown will always be full screen. This parent-less
- window serves as the application window, all other windows descend from it, even
- if they don't have a parent from Qt's perspective. It is not possible to re-parent this
- window to another window and when it is deleted any other window will vanish, as well.
-
- In general, it is not possible to promote child windows to top level windows
- (\l{QWindow::}{setParent()} with an argument of \c 0). If you do so, the window will
- vanish along with its child windows.
-
- \section1 Working Directory
-
- Applications are restricted to their working directory (aka \e sandbox), they cannot
- read or write outside this directory. Nevertheless absolute file paths are visible,
- for instance calling QDir::currentPath() will initially yield
- \c{/accounts/1000/appdata/namespace.application/}. This is the root directory an
- application is confined to. A more detaild overview how to work with the file system
- can be found in the corresponding
- \l{Working with the file system}{BlackBerry 10 documentation}.
-
- \section1 Application Lifecycle
-
- A detailed overview of the states an application can move through can be found
- \l{BlackBerry 10 application lifecycle}{here}.
- Most of the transitions are mapped to Qt signals and events. For instance, if the
- application is minimized a QGuiApplication::applicationStateChanged signal is emitted
- with an argument of \c Qt::ApplicationInactive and a QExposeEvent is sent to the application
- window. In the cases where this is not sufficient, a native event filter can
- be use, that listens for navigator events. The navigator on the BlackBerry 10 OS
- handles the entire application window lifecycle.
-
- \section1 Peculiarities
-
- This is a list of topics specific to Blackberry 10 which are discussed in their
- own sections:
-
- \list
- \li \l{QAbstractNativeEventFilter::nativeEventFilter()}{Native events}
- \li \l{Platform Limitations}{QSettings}
- \li \l{Blackberry Peculiarities}{Cover windows}
- \endlist
-
- \section1 Multimedia
- Restrictions that apply to Qt Multimedia on BlackBerry are described
- \l{Qt Multimedia on BlackBerry}{here}.
-
- \section1 Sensors
-
- Most sensors are supported on BlackBerry (such as accelerometer, compass, magnetometer,
- gyroscope, (IR) proximity, (ambient) light, orientation, rotation and holster sensors).
- However, different devices might support a different set of sensors.
- \l{ QSensor::sensorTypes()} will return a list of sensors that are supported on a
- particular device.
-
- \section1 Relationship to Cascades
-
- Cascades is the prevailing UI framework for BlackBerry 10 development. It uses Qt (4.8)
- C++ and QML as a base to provide a standard set of UI controls and other APIs tailored to
- the BlackBerry 10 platform. If you are curious, take a look at the
- \l{http://developer.blackberry.com/native/documentation/cascades/getting_started/intro/index.html}
- {Introduction to Cascades} article.
- Note that Cascades uses its own backend to render on the screen and uses only non-UI
- parts of Qt. It is not possible to mix Qt and Cascades APIs to access the screen in
- one application.
-
- \section1 Qt Widgets Style
-
- If the UI of your application is based on \l[QtWidgets]{Qt Widgets}, you should consider
- using the BlackBerry 10 specific Qt widget style. This style matches the system-wide UI
- appearance and improves usability. The BlackBerry 10 style is implemented as proxy style
- in C++ and is loaded as a style plug-in on demand. The style is available only on Qt
- builds for BlackBerry 10 and is not available in builds for other platforms.
-
- There are two variants of the style fitting the dark and bright themes on the
- BlackBerry 10.1.x and 10.2.x releases:
-
- \table 50%
- \header
- \li Style key \c{bb10bright}
- \li Style key \c{bb10dark}
- \row
- \li \image bb10bright-style.png
- \li \image bb10dark-style.png
- \endtable
-
-
- You can activate one of the styles with \l{ QApplication::setStyle() }, e.g.
-
- \code
- QApplication::setStyle(QStringLiteral("bb10dark"));
- \endcode
-
- The BlackBerry 10 style only covers those \l[QtWidgets]{Qt Widgets} which fit well on
- small screens and can be controlled with touch input in a comfortable way:
-
- \list
- \li \l{QCheckBox}
- \li \l{QComboBox}
- \li \l{QLineEdit}
- \li \l{QPushButton}
- \li \l{QProgressBar}
- \li \l{QRadioButton}
- \li \l{QSlider}
- \li \l{QScrollBar}
- \li \l{QTextEdit}
- \li item view widgets
- \endlist
-
- Consider using \l{Qt Quick} for more complex UIs.
-
- \section1 References
-
- \list
- \li \l{BlackBerry 10 device characteristics}
- \endlist
-
-*/
diff --git a/doc/src/platforms/platform-notes-rtos.qdoc b/doc/src/platforms/platform-notes-rtos.qdoc
index 486793cc..91631af3 100644
--- a/doc/src/platforms/platform-notes-rtos.qdoc
+++ b/doc/src/platforms/platform-notes-rtos.qdoc
@@ -310,13 +310,6 @@
set it in the \c{install.path} variable in the \c{.pro} file of your project, see
\l{Installing Files} in the \l {QMake} documentation for more details.
- \section1 Take a look at the Qt port for BlackBerry 10
-
- The BlackBerry 10 platform is based on the QNX Neutrino RTOS. Even though BlackBerry 10
- devices and other embedded device running QNX Neutrino RTOS are very different, Qt on
- BlackBerry 10 and Qt on QNX Neutrino RTOS have a lot in common. Take a look at
- \l{Platform and Compiler Notes - BlackBerry} to learn more.
-
*/
/*!
diff --git a/doc/src/platforms/supported-platforms.qdoc b/doc/src/platforms/supported-platforms.qdoc
index ad007ca2..6a5924a9 100644
--- a/doc/src/platforms/supported-platforms.qdoc
+++ b/doc/src/platforms/supported-platforms.qdoc
@@ -45,7 +45,7 @@
compiler, or a third party compiler. Open GL (ES) 2.0,
DirectX 9 (with ANGLE), or an \l {Qt Quick 2D Renderer} {alternative
renderer} is required for \l [QtQuick] {Qt Quick} 2.
- \l [QtWidgets] {Qt Widgets}{Widgets} can be used also without
+ \l [QtWidgets] {Qt Widgets}{Widgets} can be used without
hardware acceleration.
Not all platforms supported by the Community are supported by The
@@ -93,7 +93,6 @@
The following platforms also support Qt:
\list
- \li \l{Qt for BlackBerry 10}{BlackBerry 10}
\li \l{Sailfish OS}
\endlist
@@ -191,7 +190,6 @@
\li \l{Deploying Qt Applications}
\list
\li \l{Platform and Compiler Notes - Android#Deployment}{Android}
- \li \l{Deployment on BlackBerry 10}{BlackBerry}
\li \l{Qt for iOS}{iOS}
\li \l{Qt for Linux/X11 - Deployment}{Linux/X11}
\li \l{Qt for OS X - Deployment}{OS X}
diff --git a/doc/src/qmlapp/usecases/integratingjs.qdoc b/doc/src/qmlapp/usecases/integratingjs.qdoc
index bc5fad43..6fa8623e 100644
--- a/doc/src/qmlapp/usecases/integratingjs.qdoc
+++ b/doc/src/qmlapp/usecases/integratingjs.qdoc
@@ -66,5 +66,5 @@ Then import the file into any .qml file that needs to use the functions, like th
\image qmlapp/qml-uses-integratingjs.png
For further details on the JavaScript engine used by QML, as well as the difference from browser JS, see the full
-documentation on \c {Using JavaScript Expressions with QML}.
+documentation on \l {JavaScript Expressions in QML Documents}.
*/
diff --git a/doc/src/qt5-intro.qdoc b/doc/src/qt5-intro.qdoc
index ad5b358a..19d0b811 100644
--- a/doc/src/qt5-intro.qdoc
+++ b/doc/src/qt5-intro.qdoc
@@ -68,7 +68,7 @@
\raw HTML
<br>
\endraw
- With full support for Android, iOS, WinRT, and Blackberry 10, Qt is a
+ With full support for Android, iOS, and WinRT, Qt is a
great solution for targeting the mobile markets with a single codebase.
It is fast and easy to bring existing desktop or embedded application
to mobile, by simply recompiling it.
@@ -99,7 +99,6 @@
Platform pages:
\list
\li \l{Qt for Android}
- \li \l{Qt for BlackBerry}
\li \l{Qt for iOS}
\li \l{Qt for WinRT}
\endlist
diff --git a/doc/src/qtmodules.qdoc b/doc/src/qtmodules.qdoc
index 513e6fbf..6572af3e 100644
--- a/doc/src/qtmodules.qdoc
+++ b/doc/src/qtmodules.qdoc
@@ -153,7 +153,7 @@
\row
\li \l[QtBluetooth]{Qt Bluetooth}
\li All
- \li \l{Qt for Android}{Android}, \l{Qt for BlackBerry}{BlackBerry},
+ \li \l{Qt for Android}{Android},
\l{Qt for iOS}{iOS}, \l{Qt for Linux/X11}{Linux} and \l{Qt for OS X}{OS X}
\li Provides access to Bluetooth hardware.
\row
@@ -191,7 +191,7 @@
\row
\li \l[QtNfc]{Qt NFC}
\li All
- \li \l{Qt for BlackBerry}{BlackBerry} and \l{Qt for Linux/X11}{Linux}
+ \li \l{Qt for Linux/X11}{Linux}
\li Provides access to Near-Field communication (NFC) hardware.
\row
\li \l[QtOpenGL]{Qt OpenGL}
@@ -250,7 +250,7 @@
\row
\li \l[QtSensors]{Qt Sensors}
\li All
- \li \l{Qt for Android}{Android}, \l{Qt for BlackBerry}{Blackberry}, \l{Qt for iOS}, \l{Qt for WinRT}{WinRT} and Mer.
+ \li \l{Qt for Android}{Android}, \l{Qt for iOS}, \l{Qt for WinRT}{WinRT} and Mer.
\li Provides access to sensor hardware and motion gesture recognition.
\row
\li \l[QtSerialPort]{Qt Serial Port}