summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaurice Kalinowski <maurice.kalinowski@digia.com>2014-03-20 09:54:28 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-20 13:57:35 +0100
commit626d2cf3971feb45b1ac8f2405724016c01f6b8d (patch)
tree2cc2bdb969ca8d604076a6723eaf823969aa8d82
parent0faa939b4052ba6129ca6c4f4f75e8d38b524733 (diff)
downloadqtdoc-626d2cf3971feb45b1ac8f2405724016c01f6b8d.tar.gz
Harmonize WinRT documentation with other platforms
The order or documentation is now more consistent with iOS and Android. Also added some further clarifications about requirements on the development host. Added Windows Runtime to the Getting Started List. Change-Id: I8a8b85f7a268184ec046f2a69c3b90dbe0d05549 Reviewed-by: Andrew Knight <andrew.knight@digia.com> Reviewed-by: Oliver Wolff <oliver.wolff@digia.com>
-rw-r--r--doc/src/getting-started/gettingstarted.qdoc1
-rw-r--r--doc/src/platforms/winrt.qdoc105
2 files changed, 87 insertions, 19 deletions
diff --git a/doc/src/getting-started/gettingstarted.qdoc b/doc/src/getting-started/gettingstarted.qdoc
index f887d254..3a7f0fbc 100644
--- a/doc/src/getting-started/gettingstarted.qdoc
+++ b/doc/src/getting-started/gettingstarted.qdoc
@@ -71,6 +71,7 @@
\li \l{Qt for Windows}{Windows}
\li \l{Qt for Linux/X11}{Linux/X11}
\li \l{Qt for Mac OS X}{Mac OS X}
+ \li \l{Qt for WinRT}{Windows Runtime}
\li \l{Windows CE - Introduction to using Qt}{WinCE}
\endlist
diff --git a/doc/src/platforms/winrt.qdoc b/doc/src/platforms/winrt.qdoc
index 5a044e35..d46982fa 100644
--- a/doc/src/platforms/winrt.qdoc
+++ b/doc/src/platforms/winrt.qdoc
@@ -30,6 +30,11 @@
\title Qt for WinRT
\brief Provides insight into Qt's WinRT port and how to use it.
+ Qt for WinRT allows you to run Qt applications on devices supporting the
+ Windows Store App APIs. This includes Modern UI applications in Windows 8.1
+ and up, as well as devices running the Windows RT and Windows
+ Phone 8.
+
Microsoft introduced a new design paradigm with the Windows 8 Modern UI. A
core part of this new approach is Windows Runtime (WinRT) that supports
development using different programming languages, such as C++/CX (component
@@ -39,20 +44,91 @@
run in a sandboxed environment for security reasons and support different
architectures, such as ARM and x86.
- Qt's WinRT port supports the following:
+ \section1 Requirements
+
+ Development for Windows Runtime requires a Microsoft Windows development host.
+ The minimum version supported is Windows 8.1.
+
+ Depending on your device target you will need the following tools provided
+ by Microsoft to be installed:
- \list
- \li Widgets
- \li Graphics view
- \li Touch and orientation events
- \endlist
+ \table
+ \header
+ \li Device Target
+ \li Environment
+ \row
+ \li Windows 8.1 Modern UI
+ \li Visual Studio 2013 for Windows
+ \row
+ \li Windows RT
+ \li Visual Studio 2013 for Windows
+ \row
+ \li Windows Phone 8
+ \li Visual Studio 2012 for Windows Phone
+ \endtable
+
+ If you are targeting a remote device, please follow all instructions by
+ Visual Studio to set it up correctly.
\section1 Getting Started
+ \section2 Building Applications
+
+ You can develop applications for WinRT just as any other Qt applications.
+ Use your favorite editor or IDE (such as Qt Creator) and create your
+ application or load a Qt example. Then run \c qmake and \c {nmake/jom} to
+ build your application.
+
+ \section3 Building Applications with Visual Studio
+
+ To launch your project with Visual Studio a corresponding project needs to
+ be created. \c qmake supports converting a \c .pro project into Visual
+ Studio format by passing the parameters \c -tp vc.
+
+ \code
+ qmake -tp vc <your project>.pro
+ \endcode
+
+ Be aware of using the correct match of \c qmake and Visual Studio. As the
+ Visual Studio format is generic, it does not return an immediate error if
+ for instance you open a Windows Phone project inside Visual Studio
+ for Windows.
+
+ This creates a project which supports building applications and running them
+ with Visual Studio. It does not embed Qt libraries into the package and
+ requires you to add them manually. For this purpose, the command line
+ tool \c windeployqt has been included in the installed package. To
+ enable automatic parsing of dependencies and adding the libraries and
+ dependencies into the application package, create the project with the
+ following options:
+
+ \code
+ qmake -tp vc <your project>.pro "CONFIG+=windeployqt"
+ \endcode
+
+ \section3 Building Applications with Qt Creator
+
+ You will not need to do any conversion to open your project in Qt Creator.
+ Please follow the generic instructions on how to open and build a project.
+
+ Qt Creator deploys your application on the WinRT device, if the
+ device is detected by the PC.
+
+ \note Remote PCs, such as the Surface, are not yet supported for deployment by Creator.
+
+ \section1 Building from source
+
+ We assume that you have cloned the Qt 5 repositories (or obtained
+ the Qt sources elsewhere) and followed the platform-independent
+ requirements for building Qt. The process of building Qt is found
+ in the \l{Building Qt Sources} page.
+
Qt for WinRT is always built as a cross-build, because tools, such as qmake,
- are built as desktop applications. It also does not really make a difference
- whether you target a desktop computer or a phone, except that you
- have to configure Qt using the correct \c xplatform.
+ are built as desktop applications. For compiling those, a desktop development
+ environment is required. If you have installed Visual Studio 2013 for Windows,
+ this will only create binaries for WinRT. You will need Visual Studio for
+ Windows Desktop as well to create those desktop tools.
+
The WinRT mkspec format is \c {<platform>-<architecture>-<toolchain>}
where \e platform can be \c winrt or \c winphone and architecture can be
\c arm, \c x86, or \c x64. The following is an example of building qtbase
@@ -62,16 +138,7 @@
> nmake/jom
\endcode
- To use the latest sources, check out the \c dev branch before building.
-
- \section1 Building Applications
-
- You can develop applications for WinRT just as any other Qt applications.
- Use your favorite editor or IDE (such as Qt Creator) and create your
- application or load a Qt example. Then run \c qmake and \c {nmake/jom} to
- build your application.
-
- \section1 Running Applications
+ \section1 Running Applications from Command Line
Unfortunately, running WinRT applications is not as easy, yet. Applications
can only be started as part of an application package or by registering them