summaryrefslogtreecommitdiffstats
path: root/doc/src/getting-started
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/getting-started')
-rw-r--r--doc/src/getting-started/demos.qdoc27
-rw-r--r--doc/src/getting-started/examples.qdoc83
-rw-r--r--doc/src/getting-started/installation.qdoc80
-rw-r--r--doc/src/getting-started/known-issues.qdoc53
4 files changed, 174 insertions, 69 deletions
diff --git a/doc/src/getting-started/demos.qdoc b/doc/src/getting-started/demos.qdoc
index 4527c2b..35654d2 100644
--- a/doc/src/getting-started/demos.qdoc
+++ b/doc/src/getting-started/demos.qdoc
@@ -163,4 +163,31 @@
\note The Phonon demos are currently not available for the MinGW platform.
+ \section1 Animation
+
+ \list
+ \o \l{demos/sub-attaq}{Sub-Attaq} demonstrates the features of the
+ \l{The Animation Framework}{animation framework} and
+ \l{The State Machine Framework}{state machine framework} in the production of
+ a simple game.
+ \endlist
+
+ \section1 Embedded Platforms
+
+ \list
+ \o \l{demos/embedded/anomaly}{Anomaly} is a small screen browser with kinetic scrolling.
+ \o \l{demos/embedded/desktopservices}{Embedded Desktop Services} shows how to open
+ documents using the applications associated with their file types.
+ \o \l{demos/embedded/digiflip}{Digiflip} is a digital watch with transition effects.
+ \o \l{demos/embedded/embeddedsvgviewer}{Embedded SVG Viewer} shows how to display SVG
+ drawings on embedded devices.
+ \o \l{demos/embedded/flickable}{Flickable List} shows how to display a list with kinetic scrolling.
+ \o \l{demos/embedded/flightinfo}{Flight Info} fetches information about aircraft flights from the Web.
+ \o \l{demos/embedded/fluidlauncher}{Fluid Launcher} demo application launcher for embedded screens
+ \o \l{demos/embedded/lightmaps}{Light Maps} demonstrates OpenStreetMap integration with WebKit.
+ \o \l{demos/embedded/raycasting}{Ray Casting} demonstrates the use of ray casting with the
+ \l{The Graphics View Framework}{Graphics View} framework.
+ \o \l{demos/embedded/styledemo}{Embedded Styles} demonstrates the use of styles.
+ \o \l{demos/embedded/weatherinfo}{Weather Info} fetches weather information from the Web.
+ \endlist
*/
diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc
index dd256d9..5d2057e 100644
--- a/doc/src/getting-started/examples.qdoc
+++ b/doc/src/getting-started/examples.qdoc
@@ -206,7 +206,7 @@
\o
\row
- \o{2,1} \l{OpenGL Examples}{\bold OpenGL}
+ \o{2,1} \l{OpenGL Examples}{\bold{OpenGL}}\bold{ and }\l{OpenVG Examples}{\bold{OpenVG}}\bold{ Examples}
\o{2,1} \l{Multimedia Examples}{\bold{Multimedia Framework}}
\row
\o \image opengl-examples.png OpenGL
@@ -215,6 +215,9 @@
platforms, giving developers the opportunity to display hardware accelerated
3D graphics alongside a more conventional user interface.
+ Qt provides support for integration with OpenVG implementations on
+ platforms with suitable drivers.
+
\o \image phonon-examples.png
\o
Qt provides low-level audio support on linux,windows and mac platforms by default and
@@ -299,37 +302,47 @@
to build highly animated, high-performance GUIs.
\row
+ \o{2,1} \l{Multi-Touch Examples}{\bold{Multi-Touch Framework}}
\o{2,1} \l{Gestures Examples}{\bold{Gestures}}
- \o{2,1} \l{D-Bus Examples}{\bold{D-Bus}}
+
\row
+ \o \image multitouch-examples.png
+ \o
+ Support for multi-touch input makes it possible for developers to create
+ extensible and intuitive user interfaces.
+
\o \image gestures-examples.png
\o
Applications can be written to respond to gestures as a natural input method.
These examples show how to enable support for standard and custom gestures in
applications.
- \o \image dbus-examples.png D-Bus
- \o
- D-Bus is an inter-process communication protocol for Unix/Linux systems.
- These examples demonstrate how to write application that communicate with
- each other.
\row
+ \o{2,1} \l{D-Bus Examples}{\bold{D-Bus}}
\o{2,1} \l{Qt for Embedded Linux Examples}{\bold{Qt for Embedded Linux}}
- \o{2,1} \l{ActiveQt Examples}{\bold ActiveQt}
+
\row
\o \image qt-embedded-examples.png
\o
Systems with limited resources, specialized hardware, and small
screens require special attention.
- \o \image activeqt-examples.png ActiveQt
+ \o \image dbus-examples.png D-Bus
\o
- These examples demonstrate how to write ActiveX controls and control servers
- with Qt, and how to use ActiveX controls and COM objects in a Qt application.
+ D-Bus is an inter-process communication protocol for Unix/Linux systems.
+ These examples demonstrate how to write application that communicate with
+ each other.
\row
+ \o{2,1} \l{ActiveQt Examples}{\bold ActiveQt}
\o{2,1} \l{Qt Quarterly}{\bold{Qt Quarterly}}
+
\row
+ \o \image activeqt-examples.png ActiveQt
+ \o
+ These examples demonstrate how to write ActiveX controls and control servers
+ with Qt, and how to use ActiveX controls and COM objects in a Qt application.
+
\o \image qq-thumbnail.png QtQuarterly
\o
One more valuable source for examples and explanations of Qt
@@ -706,6 +719,7 @@
\o \l{tools/customtypesending}{Custom Type Sending}\raisedaster
\o \l{tools/echoplugin}{Echo Plugin}\raisedaster
\o \l{tools/i18n}{I18N}
+ \o \l{tools/inputpanel}{Input Panel}\raisedaster
\o \l{tools/plugandpaint}{Plug & Paint}\raisedaster
\o Plug & Paint Plugins: \l{tools/plugandpaintplugins/basictools}{Basic Tools}\raisedaster
and \l{tools/plugandpaintplugins/extrafilters}{Extra Filters}\raisedaster
@@ -776,7 +790,7 @@
\previouspage Inter-Process Communication Examples
\contentspage Qt Examples
- \nextpage Multimedia Examples
+ \nextpage OpenVG Examples
\image opengl-examples.png
@@ -793,6 +807,7 @@
\o \l{opengl/framebufferobject2}{Framebuffer Object 2}
\o \l{opengl/grabber}{Grabber}
\o \l{opengl/hellogl}{Hello GL}\raisedaster
+ \o \l{opengl/hellogl_es}{Hello GL - ported to Windows CE}\raisedaster
\o \l{opengl/overpainting}{Overpainting}\raisedaster
\o \l{opengl/pbuffers}{Pixel Buffers}
\o \l{opengl/pbuffers2}{Pixel Buffers 2}
@@ -804,6 +819,27 @@
*/
/*!
+ \page examples-openvg.html
+ \title OpenVG Examples
+
+ \previouspage OpenGL Examples
+ \contentspage Qt Examples
+ \nextpage Multimedia Examples
+
+ \image openvg-examples.png
+
+ Qt provides support for integration with OpenVG implementations on
+ platforms with suitable drivers.
+
+ These examples demonstrate the basic techniques used to take advantage of
+ OpenVG in Qt applications.
+
+ \list
+ \o \l{openvg/star}{OpenVG Star}
+ \endlist
+*/
+
+/*!
\page examples-multimedia.html
\title Multimedia Examples
@@ -1096,7 +1132,7 @@
\previouspage State Machine Examples
\contentspage Qt Examples
- \nextpage Gestures Examples
+ \nextpage Multi-Touch Examples
\image animation-examples.png Animation
@@ -1113,10 +1149,29 @@
*/
/*!
+ \page examples-multitouch.html
+ \title Multi-Touch Examples
+
+ \previouspage Animation Framework Examples
+ \contentspage Qt Examples
+ \nextpage Gestures Examples
+
+ Support for multi-touch input makes it possible for developers to create
+ extensible and intuitive user interfaces.
+
+ \list
+ \o \l{multitouch/dials}{Multi-Touch Dials}
+ \o \l{multitouch/fingerpaint}{Finger Paint}
+ \o \l{multitouch/knobs}{Multi-Touch Knobs}
+ \o \l{multitouch/pinchzoom}{Pinch Zoom}
+ \endlist
+*/
+
+/*!
\page examples-gestures.html
\title Gestures Examples
- \previouspage Animation Framework Examples
+ \previouspage Multi-Touch Examples
\contentspage Qt Examples
\nextpage D-Bus Examples
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index c8e225c..057629d 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -495,12 +495,12 @@ in the \l{Qt for Windows CE Requirements} document.
*/
/*! \page install-Symbian-installer.html
-\title Installing Qt on the Symbian Platform from a Binary Package
-\ingroup qts60
+\title Installing Qt on the Symbian platform from a Binary Package
+\ingroup qtsymbian
\brief How to install Qt on the Symbian platform from a binary package.
-\note Qt for Symbian platform has some requirements that are given in more detail
-in the \l{Qt for Symbian platform Requirements} document.
+\note Qt for the Symbian platform has some requirements that are given in more detail
+in the \l{Qt for the Symbian platform Requirements} document.
\list 1
@@ -517,13 +517,16 @@ in the \l{Qt for Symbian platform Requirements} document.
to try out. An excellent starting point is the "fluidlauncher"
demo. To run the demo on a real device, you first have to install
\c{qt.sis} and \c{fluidlauncher.sis} found in the Qt installation
- directory. Begin by connecting your phone using the USB cable and
- selecting "PC Suite mode". In Windows Explorer right click on the
- \c{.sis} files and select "Install with Nokia Application Installer"
+ directory. Also, check if the device needs additional
+ \l{Qt for the Symbian platform Requirements}{requirements}.
+ Begin by connecting your device via USB cable to a computer that has
+ the \l{http://www.nokia.com/pcsuite}{Nokia PC Suite} installed.
+ On the device, select "PC Suite mode". In Windows Explorer right click
+ on the \c{.sis} files, select "Install with Nokia Application Installer"
and follow the instructions.
To run the demos and examples on the emulator, you need to build them first.
- Open the "Qt for Symbian platform Command Prompt" from the Start menu and type:
+ Open the "Qt for the Symbian platform Command Prompt" from the Start menu and type:
\snippet doc/src/snippets/code/doc_src_installation.qdoc 25
@@ -534,7 +537,7 @@ in the \l{Qt for Symbian platform Requirements} document.
For more information about building and running Qt programs on the
Symbian platform,
- see \l{Symbian platform - Introduction to Qt}.
+ see \l{The Symbian platform - Introduction to Qt}.
We hope you will enjoy using Qt.
@@ -542,25 +545,40 @@ Symbian platform,
*/
/*! \page install-Symbian.html
-\title Installing Qt on the Symbian Platform
+\title Installing Qt on the Symbian platform
\ingroup installation
-\ingroup qts60
+\ingroup qtsymbian
\brief How to install Qt on the Symbian platform.
\note Qt for the Symbian platform has some requirements that are given in more detail
-in the \l{Qt for Symbian Platform Requirements} document.
+in the \l{Qt for the Symbian platform Requirements} document.
\note \bold {This document describes how to install and configure Qt for
the Symbian platform from scratch.
If you are using pre-built binaries, follow the instructions given in the
-\l{Installing Qt on the Symbian Platform from a Binary Package} document.}
+\l{Installing Qt on the Symbian platform from a Binary Package} document.}
\list 1
+ \o Setup the development environment
+
+ Make sure your Symbian development environment is correctly installed and
+ patched as explained in the \l{Qt for the Symbian platform Requirements} document.
+
+ After you have finished the Symbian development environment setup, it is good
+ to verify that environment is functional for example by compiling one
+ of the pure Symbian examples for both emulator and HW. This can be done from
+ command prompt as follows:
+
+ \snippet doc/src/snippets/code/doc_src_installation.qdoc 32
+
+ If all steps pass without errors your Symbian development environment is
+ very likely installed correctly.
+
\o Install Qt
- Uncompress the package into the directory you want Qt installed,
- e.g. \c{C:\Qt\%VERSION%}.
+ Uncompress the \l{http://qt.nokia.com/downloads}{downloaded} source package into the
+ directory you want Qt installed, e.g. \c{C:\Qt\%VERSION%}.
\note Qt must be installed on the same drive as the Symbian SDK you are
using, and the install path must not contain any spaces.
@@ -581,6 +599,13 @@ If you are using pre-built binaries, follow the instructions given in the
emulator. This is done by locating the Carbide.c++ submenu on the Start
menu, and choosing "Configure environment for WINSCW command line".
+ If you are planning to use abld (the default build system that comes with the S60 SDK)
+ to build Qt, you will also need to set the following environment variable:
+
+ \snippet doc/src/snippets/code/doc_src_installation.qdoc 33
+
+ This is not necessary for other applications, only when building Qt.
+
\o Configure Qt
To configure Qt for the Symbian platform, do:
@@ -589,10 +614,11 @@ If you are using pre-built binaries, follow the instructions given in the
to build the tools using MinGW, and the libraries using abld.
or
\snippet doc/src/snippets/code/doc_src_installation.qdoc 31
- to build the tools using MinGW, and the libraries using sbsv2.
+ to build the tools using MinGW, and the libraries using SBSv2.
- For other options, type \c{configure -help} to get a list of all available
- options.
+ SBSv2 also known as a (\l{http://developer.symbian.org/wiki/index.php/Introduction_to_RAPTOR} {Raptor})
+ is a next-generation Symbian build system. SBSv2 is not officially
+ supported by any of the S60 SDKs currently available from Forum Nokia.
\o Build Qt
@@ -631,7 +657,7 @@ If you are using pre-built binaries, follow the instructions given in the
\snippet doc/src/snippets/code/doc_src_installation.qdoc 27
For more information about building and running Qt programs on the
-Symbian platform, see \l{Symbian platform - Introduction to Qt}.
+ Symbian platform, see \l{The Symbian platform - Introduction to Qt}.
We hope you will enjoy using Qt.
@@ -666,7 +692,7 @@ Symbian platform, see \l{Symbian platform - Introduction to Qt}.
\list
\o \l{Qt for Embedded Linux Requirements}
\o \l{Qt for Mac OS X Requirements}
- \o \l{Qt for Symbian platform Requirements}
+ \o \l{Qt for the Symbian platform Requirements}
\o \l{Qt for Windows CE Requirements}
\o \l{Qt for Windows Requirements}
\o \l{Qt for X11 Requirements}
@@ -951,12 +977,12 @@ Symbian platform, see \l{Symbian platform - Introduction to Qt}.
/*!
\page requirements-symbian.html
- \title Qt for Symbian Platform Requirements
+ \title Qt for the Symbian platform Requirements
\ingroup installation
\brief Setting up the Symbian platform environment for Qt.
\previouspage General Qt Requirements
- Qt for Symbian platform requires the following software installed on your development PC:
+ Qt for the Symbian platform requires the following software installed on your development PC:
\list
\o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/carbide_cpp/}{Carbide.c++ v2.0.0 or higher}
\list
@@ -969,7 +995,11 @@ Symbian platform, see \l{Symbian platform - Introduction to Qt}.
\o \bold{Note:} According to Symbian, version 5.6.1 build 638 is mandatory. Using later versions may result in unexplained errors.
\endlist
\o \l{http://www.forum.nokia.com/main/resources/tools_and_sdks/S60SDK/}{S60 Platform SDK 3rd Edition FP1 or higher}
- \o \l{http://www.forum.nokia.com/main/resources/technologies/openc_cpp/}{Open C/C++ v1.6.0 or higher}.
+ \list
+ \o \bold{Note:} Users of \bold{S60 Platform SDK 3rd Edition FP1} also need special update. The update can be found
+ \l{http://pepper.troll.no/s60prereleases/patches/}{here}.
+ \endlist
+ \o \l{http://www.forum.nokia.com/main/resources/technologies/openc_cpp/}{Open C/C++ v1.6.0 or higher}.
Install this to all Symbian SDKs you plan to use Qt with.
\o Building Qt tools from scratch requires \l{http://www.mingw.org/}{MinGW 3.4.5 or higher}, or another windows compiler.
\list
@@ -987,8 +1017,8 @@ Symbian platform, see \l{Symbian platform - Introduction to Qt}.
\o \c{nokia_plugin\opencpp\s60opencppsis\stdcpp_s60_<version>.sis}
\endlist
- \note Users of \bold{S60 Platform SDK 3rd Edition FP1} also need special updates. The update can be found
- \l{http://pepper.troll.no/s60prereleases/patches/}{here}.
+ We recommend you to take a look of \l{http://developer.symbian.org/wiki/index.php/Qt_Quick_Start}{Symbian Foundation - Qt Quick Start}
+ to get more information about how to setup the development environment.
\sa {Known Issues in %VERSION%}
*/
diff --git a/doc/src/getting-started/known-issues.qdoc b/doc/src/getting-started/known-issues.qdoc
index 0b63423..b8c2192 100644
--- a/doc/src/getting-started/known-issues.qdoc
+++ b/doc/src/getting-started/known-issues.qdoc
@@ -59,57 +59,35 @@
\section1 Installation Issues
- \section2 Building the Source Package on Windows 7
+ \section2 Installing the Source Package on Unix systems
\list
- \o When building Qt 4.5.0 with Windows 7, the build fails with an error
- message regarding failing to embed manifest. This a known issue with
- Windows 7, explained in the Windows 7 SDK Beta
- \l{http://download.microsoft.com/download/8/8/0/8808A472-6450-4723-9C87-977069714B27/ReleaseNotes.Htm}
- {release notes}. A workaround for this issue is to patch the
- \bold{embed_manifest_exe.prf} file with the following:
-
- \code
- diff --git a/mkspecs/features/win32/embed_manifest_exe.prf b/mkspecs/features/win32/embed_manifest_exe.prf
- index e1747f1..05f116e 100644
- --- a/mkspecs/features/win32/embed_manifest_exe.prf
- +++ b/mkspecs/features/win32/embed_manifest_exe.prf
- @@ -8,4 +8,9 @@ if(win32-msvc2005|win32-msvc2008):!equals(TEMPLATE_PREFIX, "vc"):equals(TEMPLATE
- QMAKE_POST_LINK = $$quote(mt.exe -nologo -manifest \"$$replace(OBJECTS_DIR,/,\\)\\$${NOPATH_TARGET}.intermediate.ma
- nifest\" -outputresource:$(DESTDIR_TARGET);1$$escape_expand(\n\t))
- QMAKE_POST_LINK += $$QMAKE_PREV_POST_LINK
- QMAKE_CLEAN += \"$$replace(OBJECTS_DIR,/,\\)\\$${NOPATH_TARGET}.intermediate.manifest\"
- + isEmpty(RC_FILE) {
- + system("echo.>$$replace(OUT_PWD,/,\\)\\$$replace(OBJECTS_DIR,/,\\)\\Windows7WorkAround.rc")
- + RC_FILE = $$replace(OUT_PWD,/,\\)\\$$replace(OBJECTS_DIR,/,\\)\\Windows7WorkAround.rc
- + }
- +
- }
- \endcode
-
- \section2 Installing the Source Package on Unix systems
\o If you download a Zip source package, you will need to convert
Windows-style line endings (CR/LF) to Unix-style line-endings (LF) when
you uncompress the package. To do this, give the "-a" option when you
run the "unzip' command.
-
- If you fail to supply the "-a" option when unzipping the package, you
+
+ \o If you fail to supply the "-a" option when unzipping the package, you
will see the following error message when you attempt to execute the
configure command:
"bash: ./configure: /bin/sh^M: bad interpreter: No such file or directory"
+
\endlist
\section2 Installing on Mac OS X 10.6 "Snow Leopard"
+
\list
+
\o Performing a new install of the Qt 4.6 beta on Snow Leopard
triggers a bug in the installer that causes the install to fail.
Updating an existing Qt installation works fine.
- There are two workarounds, either disable spotlight for the target
+ \o There are two workarounds, either disable spotlight for the target
drive during the install, or do a custom install where you deselect
documentation and examples. Run the installer again as a full
install to get the documentation and examples installed.
+
\endlist
\section1 Issues with Third Party Software
@@ -135,6 +113,7 @@
\section2 Windows
\list
+
\o When using version 6.14.11.6921 of the NVIDIA drivers for the GeForce
6600 GT under Windows XP, Qt applications which use drag and drop will
display reduced size drag and drop icons when run alongside
@@ -150,13 +129,27 @@
\o A bug in the Firebird database can cause an application to crash when
\c{fbembed.dll} is unloaded. The bug is fixed in version 2.5.
+ \o On Windows 7, resizing windows is slower than on Vista/Xp. This is because
+ the gesture initialization process (required for native gesture support)
+ currently calls winId() on widgets, which causes whole widget hierarchies
+ to use native window handles. This slows down resizing.
+
\endlist
\section2 Mac OS X
\list
+
\o If a sheet is opened for a given window, clicking the title bar of that
window will cause it to flash. This behavior has been reported to Apple
(bug number 5827676).
+
+ \endlist
+
+ \section2 Symbian
+
+ \list
+ \o Check known issues for Symbian at
+ \l{http://qt.gitorious.org/qt/pages/Qt460KnownIssues} {Known Issues Wiki}.
\endlist
*/