diff options
| author | David Laing <david.laing@nokia.com> | 2010-06-30 14:11:18 +1000 |
|---|---|---|
| committer | David Laing <david.laing@nokia.com> | 2010-06-30 14:11:18 +1000 |
| commit | 26bd94234dbb79a632c79e8540bb34b0da83ef7c (patch) | |
| tree | 46e55c9eb1cc879c177bf7f0e4c0e0b91d4ea5c8 /doc/src | |
| parent | d82d68d9e49ff5094a7d37dcef013fa8233b5be5 (diff) | |
| parent | 38f012dc2000507ab115db1b7137295ffa44aa84 (diff) | |
Merge branch 'master' of ../../mainline/qtmobility
Conflicts:
doc/html/classes.html
doc/html/functions.html
doc/html/qt-mobility-project-library.dcf
doc/html/qt-mobility-project-library.index
doc/html/qtmobility.qhp
plugins/plugins.pro
src/location/liblocationwrapper.cpp
Diffstat (limited to 'doc/src')
28 files changed, 1359 insertions, 1156 deletions
diff --git a/doc/src/bearermanagement.qdoc b/doc/src/bearermanagement.qdoc index 3aa9252e99..6ed567c92a 100644 --- a/doc/src/bearermanagement.qdoc +++ b/doc/src/bearermanagement.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/camera.qdoc b/doc/src/camera.qdoc new file mode 100644 index 0000000000..1e5c810cd3 --- /dev/null +++ b/doc/src/camera.qdoc @@ -0,0 +1,192 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. +** +** GNU Free Documentation License +** 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. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + + +/*! + +\page camera.html + +\title Camera +\brief An API to control camera devices. + +\ingroup mobility + + +\note This API and documentation is a \bold {Technology Preview} and is still +subject to change. + + +The Camera API provides control of system camera devices. Providing support +for still or video image capture with sound support. + + +\tableofcontents + + +\section1 Overview + +The Camera API allows high level control of various aspects of still images +and video. Camera is a part of the Multimedia API and this relationship is +apparent when you notice that certain core classes are subclassed from some +Multimedia base classes including \l QMediaObject and \l QMediaControl. + + + +\section1 Still Images + +In order to capture an image we need to create a \l QCamera object and use +it to initialize a \l QVideoWidget, so we can see where the camera is +pointing - a viewfinder. The camera object is also used to initialize a new +QStillImageCapture object, imageCapture. All that is then needed is to start +the camera, lock it so that the settings are not changed while the image +capture occurs, capture the image, and finally unlock the camera ready for +the next photo. + + \code + camera = new QCamera; + viewFinder = new QCameraViewfinder(); + viewFinder->show(); + + camera->setViewfinder(viewFinder); + + imageCapture = new QStillImageCapture(camera); + + camera->start(); + + //on half pressed shutter button + camera->lock(); + + ... + + //on shutter button pressed + imageCapture->capture("imagefile.jpg"); + + //on shutter button released + camera->unlock(); + \endcode + +Alternatively, we could have used a QVideoWidget initialized with the camera +object to create a view finder. + + + +\section1 Video Clips + +Previously we saw code that allowed the capture of a still image. Recording +video requires the use of a \l QMediaRecorder object and a \l +QAudioCaptureSource for sound. + +To record video we need to create a camera object as before but this time as +well as creating a viewfinder, we will also initialize a media recorder object +and an audio source object for sound configuration details. + + \code + mediaRecorder = new QMediaRecorder(camera); + ... + audioSource = new QAudioCaptureSource(camera); + \endcode + +Signals from the \i mediaRecorder can be connected to slots to react to +changes in the state of the recorder or error events. Recording itself +starts with the \l {QMediaRecorder::record()}{record()} function of +mediaRecorder being called, this causes the signal \l +{QMediaRecorder::stateChanged()}{stateChanged()} to be emitted. The +recording process can be changed with the \l {QMediaRecorder::record()}{record()}, +\l {QMediaRecorder::pause()}{pause()}, \l {QMediaRecorder::stop()}{stop()} and +\l {QMediaRecorder::setMuted()}{setMuted()} slots in \l QMediaRecorder. + +When the camera is in video mode, as decided by the application, then as the +shutter button is pressed the camera is locked as before but instead the +\l {QMediaRecorder::record()}{record()} function in \l QMediaRecorder is used. + + + +\section1 Focus + +Focusing is managed by the classes \l QCameraFocus and \l QCameraFocusControl. +QCameraFocus allows the developer to set the general policy by means of the +enums for the \l {QCameraFocus::FocusMode}{FocusMode} and the +\l {QCameraFocus::FocusPointMode}{FocusPointMode}. \l FocusMode deals with +settings such as \l AutoFocus, \l ContinuousFocus and \l InfinityFocus, whereas +\l FocusPointMode deals with the various focus zones within the view. +\l FocusPointMode has support for face recognition, center focus and a custom +focus where the focus point can be specified. + + + +\section1 Cancelling Asynchronous Operations + +Various operations such as image capture and auto focusing occur +asynchrously. These operations can often be cancelled by the start of a new +operation as long as this is supported by the backend. For image capture, +the operation can be cancelled by calling +\l {QStillImageCapture::cancelCapture()}{cancelCapture()}. For AutoFocus, +autoexposure or white balance cancellation can be done by calling +\i {QCamera::unlock(QCamera::LockFocus)}. + + + +\section1 Camera Controls + + \table + \header + \o Control Name + \o Description + \row + \o camera + \o the interface for system camera devices + \row + \o burst control + \o capturing multiple images as fast as possible + \row + \o bracketing + \o Capture a number of images with different camera settings + \row + \o exposure + \o Includes: flash mode; flash power; metering mode; aperture; shutter speed, iso setting + \row + \o focus + \o Includes: optical zoom; digital zoom; focus point; focus zones + \row + \o image processing + \o white balance; contrast; saturation; sharpen; denoise + \row + \o locks + \o handles the locking and unlocking of camera devices + \row + \o viewfinder + \o used to set displayed items and resolution + \endtable + + +\section1 Classes +\annotatedlist camera + + +*/ + + diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc index 172e5d316d..a9d872c559 100644 --- a/doc/src/classes.qdoc +++ b/doc/src/classes.qdoc @@ -6,39 +6,26 @@ ** ** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \group classlists \title Class and Function Documentation diff --git a/doc/src/contacts.qdoc b/doc/src/contacts.qdoc index 1b973b9419..b21baa0c81 100644 --- a/doc/src/contacts.qdoc +++ b/doc/src/contacts.qdoc @@ -4,41 +4,28 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \page contacts.html diff --git a/doc/src/contactsasync.qdoc b/doc/src/contactsasync.qdoc index b594d98ae9..28c1027a06 100644 --- a/doc/src/contactsasync.qdoc +++ b/doc/src/contactsasync.qdoc @@ -4,41 +4,28 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \page contactsasync.html diff --git a/doc/src/contactsengines.qdoc b/doc/src/contactsengines.qdoc index b920440f0c..043c8fd39d 100644 --- a/doc/src/contactsengines.qdoc +++ b/doc/src/contactsengines.qdoc @@ -4,41 +4,28 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \page contactsengines.html diff --git a/doc/src/contactsschema.qdoc b/doc/src/contactsschema.qdoc index 3b03898f35..ea59a17eb7 100644 --- a/doc/src/contactsschema.qdoc +++ b/doc/src/contactsschema.qdoc @@ -4,41 +4,28 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + /*! \page contactsschema.html diff --git a/doc/src/contactssync.qdoc b/doc/src/contactssync.qdoc index cafd9ce807..562648a609 100644 --- a/doc/src/contactssync.qdoc +++ b/doc/src/contactssync.qdoc @@ -4,41 +4,29 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ + + /*! \page contactssync.html diff --git a/doc/src/contactsusage.qdoc b/doc/src/contactsusage.qdoc index 8d8a493c0a..cf57fb3380 100644 --- a/doc/src/contactsusage.qdoc +++ b/doc/src/contactsusage.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/examples.qdoc b/doc/src/examples.qdoc index 931b63a6d6..a67e681efe 100644 --- a/doc/src/examples.qdoc +++ b/doc/src/examples.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ @@ -81,11 +67,9 @@ \list \o \l{audiorecorder}{Audio Recorder} - \o \l{cameracapture}{Camera Capture} \o \l{player}{Player} \o \l{radio}{Radio} \o \l{slideshow}{Slideshow} - \o \l{streamplayer}{Stream Player} \endlist \section2 Publish and Subscribe diff --git a/doc/src/future.qdoc b/doc/src/future.qdoc index d232652b60..b89a89ce2b 100644 --- a/doc/src/future.qdoc +++ b/doc/src/future.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 30e1048d4b..8af388dbe9 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -1,499 +1,591 @@ -/**************************************************************************** -** -** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). -** All rights reserved. -** Contact: Nokia Corporation (qt-info@nokia.com) -** -** This file is part of the Qt Mobility Components. -** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. -** -** If you have questions regarding the use of this file, please contact -** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \group mobility - \title Qt Mobility Project APIs - - Qt Mobility Project supplies a set of new APIs for Qt enabling a range of - mobile-centric technologies and features on mobile and non-mobile platforms. - -*/ - - - -/*! - \page index.html - \startpage index.html Qt Reference Documentation - - \title Qt Mobility Project APIs Overview - - \brief An overview of the Qt Mobility Project APIs. - - Qt Mobility Project delivers a set of new APIs to Qt with features - that are well known from the mobile device world, in particular phones. - However, these APIs allow the developer to use these features with ease - from one framework and apply them to phones, netbooks and non-mobile - personal computers. The framework not only improves many aspects of a - mobile experience, because it improves the use of these technologies, - but has applicability beyond the mobile device arena. - - \tableofcontents - - - - \section1 Overview - - \section2 Introducing the New Qt APIs - - Qt Mobility covers a wide range of features and technologies so it best - to regard it not as a single API but as a collection of APIs or frameworks. - - This release contains the following APIs: - - \annotatedlist mobility - - These APIs give the developer a range of desirable functions for a - mobile platform, but now these functions become possible on platforms not - traditionally associated with some of the features. A mobile device - using the Qt Mobility Project API would be able to - \list - \o Locate services on-board or remotely. Find an optimal - connection to the network for the particular service. - \o Services built on top of these APIs would include Internet - applications such as email and web browsing. - \o Multimedia features enable image and video capture with audio , - audio recording, and the playing of music or video clips. - \o Location will make the device aware of its geographical location - to support GIS applications. - \o Publish-Subscribe enables communication between separate objects - whether local or remote to the device. - \endlist - - The New Qt APIs deliver to developers an enabling package. It - will be used by developers to build a variety of applications and - services that are mobile capable or familiar to mobile users, - irrespective of whether the platform is mobile or not. This means that - there is the possibility of easy transfer of user experience from PC to - phone or vice versa. - - \section1 Namespace - - The QtMobility APIs are placed into the \i{QtMobility} namespace, with - the important exception of Multimedia. This is done to facilitate the - future migration of Mobility APIs into Qt. - - See the \l {Quickstart Example}{Quickstart guide} for an example on how - the namespace impacts on application development. - - \section1 Getting Started - To get started with Qt Mobility see the - \list - \o \l {Installation Guide} - \o \l {Quickstart Example} - \o \l {Qt Mobility Examples}{List of all examples.} - \endlist - - For users on the supported Symbian platforms, shown at the bottom of this - page, see the instructions at the - \l{http://library.forum.nokia.com/topic/Qt_for_Symbian_Developers_Library/GUID-7E53D0F7-72CB-41C4-8807-FE7A772B0DB4.html}{Qt For Symbian Developer's Library} - - \section2 Known Issues - For a list of known issues and an additional details on feature supported see - \l {Release Notes of the QtMobility Project}. - - For a overview of Platform Compatibility see \l {Platform Compatibility}. - - \section1 The New Qt APIs - \section2 Bearer Management - - Although not a network manager, this component manages the connectivity - state of the device to the network. So it does not manage network - configurations, which are the role of the platform provider, but it does - allow the user to start or stop network interfaces. Some higher level - management of the connection session may also be possible as well - depending on the platform. - - Some platforms can have a set of grouped access points perhaps based on a - common purpose. Bearer Management allows comparison and prioritization - of the access and use of these points. - - The aim of Bearer Management is to reduce the need for the developer to be - concerned about trying to locate the best connection from a list of - possible IP bearers and 3G connections. The user can select the best or - it can be selected transparently so that WLAN roaming can occur - seemlessly. - - Some examples of the Bearer Management functionality, - \list - \o On demand use of the appropriate Access Point. When a user starts - to use a browser, the appropriate access point is selected from those - available and a connection is transparently made. - \o Always-on applications such as email or IM roam automatically - between cellular packet data and WLAN networks. The application developer - is in control and for example the application can gracefully close TCP - connections over the old bearer after setting up new TCP connections - over the new bearer. - \o Application developer can create a settings user interface, where - the user can select a certain connection to be used with the application - \o A connection manager application can be implemented with Qt. This - application enumerates available connections, shows counters, and allows - the user to connect or disconnect - \endlist - - For more details, see the \l {Bearer management} {Bearer Management API overview}. - - \section2 Contacts - - The structure and retrieval of contact data from local or remote backends. - It includes the ability to create, edit, list, delete and lookup contact - information whether it is stored locally or remotely. - - For more details, see the \l {Contacts} {Contacts API overview}. - - \section2 Publish and Subscribe - - Will enable context sensitive access to information in future releases. - Data is organized as a tree, with data being able to 'shadow' other - data with the 'same key', a string specifying the leaf or node. The - context is an example of a context ontology, a defined set of - relationships. As the context changes the values of the objects change - but the relationships remain the same. It is intended to be an enabling - technology, the basis of a range future applications. - - At this stage the API is intended to act as a common communications - method between applications, whether local or remote. - - For more details, see the \l {Publish and Subscribe} {Publish and Subscribe API overview}. - - \section2 Location - - The C++ API is one layer of this feature. This API provides an easy to - use interface that encapsulates basic geographical information obtained - from satellite or other sources about the user, including latitude and - longitude, bearing, speed and altitude. It will enable a range of - geographical applications, for example, maps. - - For more details, see the \l {Location} {Location API overview}. - - \section2 Messaging - - A common interface for handling SMS, MMS, MIME Email and TNEF Email - messages. Enables access to messaging services to search and sort - messages, notify of changes to messages stored, send messages - with or without attachments, retrieve message data, and launch the - preferred messaging client to either display an existing message, - or compose a message. - - For more details see the \l {Messaging} {Messaging API overview}. - - \section2 Multimedia - - An API to play audio and video of various formats. Record audio. The playing - and managing of an FM radio. This includes the typical functionality you - would find on a music and video player, combined with an FM radio. - - For more details see the \l {Multimedia} {Multimedia API overview}. - - \section2 Sensors - - An API for accessing hardware sensors. This covers both high-level - sensors such as screen orientation (portrait, landscape) and low-level, - real-time sensors such as accelerometer data. - - For more details see the \l{Sensors API}{Sensors API overview}. - - \section2 Service Framework - - A platform independent method of finding Services. A 'service' is an - independent component that allows a client to perform a well-defined - operation. - - The services are implemented as plugins installed on the device and can - look for supporting external services running on a central server. E.g. - weather, local tourist attractions etc. Default applications can use - the layer to locate servers. - - Since this is an abstraction layer then the app does not need to be - concerned with the underlying protocol, where the servers are, the - hardware peculiarities with networking and other low level details. - - For more details see the \l {Qt Service Framework} {Service Framework API overview}. - - \section2 System Information - - An API to discover system related information and capabilities. Information - available will cover software version numbers, hardware features, - network connection types and status, display, data storage devices, - device information and the screensaver. - - For more details see the \l {System Information} {System Information API overview}. - - \section2 Versit - - An API to manage Versit \reg documents, such as vCards. - - For more details see the \l{Versit API}{Versit API overview}. - - \section1 The QtMobility Namespace - - The QtMobility APIs are placed into the QtMobility namespace. This is - done to facilitate the future migration of Mobility APIs into Qt. See - the \l {Quickstart Example}{Quickstart guide} for an example on how - the namespace impacts on application development. - - - \section1 Platform Compatibility - - - \raw HTML - - <table cellpadding="2" cellspacing="1" border="0"> - <tbody> - <tr> - <td>Color</td> - <td>Explanation</td> - - </tr> - </tr> - <tr> - <td bgcolor="green"></td> - <td>A functional backend for the API on the platform is complete.</td> - </tr> - <tr> - <td bgcolor="yellow"></td> - <td>A functional backend for the API on the platform is being worked however it is not functionally complete.</td> - - </tr> - <tr> - <tr> - <td bgcolor="lightgray"></td> - <td>A functional backend for the API on the platform is being worked on. At this point it is far from functionally complete or there is no platform specific code inside QDF source code.</td> - </tr> - <tr> - <td bgcolor="gray"></td> - <td>A functional backend for the API on the platform is not being worked on. It is possible for others to implement and integrate support.</td> - </tr> - </tbody> - </table> - <br> - - <b>Tier 1 Platforms</b><br> - Primary platforms are the main focus of Mobility API. There platforms are frequently tested by our unit test suite and other internal testing tools. However, the timeline of availability for each backend is subject to change. - <br> - <b>Tier 2 Platforms</b><br> - Secondary platforms include future direction of Qt Mobility API. Contributions to these platforms are welcome. - <br> - <br> - <table align="center" cellpadding="2" cellspacing="1" border="1"> - <tbody> - <tr> - <td rowspan="2"> </td> - <td rowspan="2"><b>API Maturity Level</b></td> - <td colspan="5" align="center" bgcolor="#96E066"><b>Tier 1 Platforms</b></td> - - <td colspan="4" align="center" bgcolor="#96E066"><b>Tier 2 Platforms</b></td> - </tr> - <tr> - <td width="9%"><b>S60 3rd Edition, Feature Pack 1</b></td> - <td width="9%"><b>S60 3rd Edition, Feature Pack 2</b></td> - <td width="9%"><b>S60 5th Edition</b></td> - <td width="9%"><b>Symbian^3</b></td> - <td width="9%"><b>Maemo 5</b></td> - <td width="9%"><b>Windows CE/Mobile<b></b></b></td> - <td width="9%"><b>Windows XP/Vista</b></td> - - <td width="9%"><b>Linux</b></td> - <td width="9%"><b>Mac OS X</b></td> - </tr> - <tr> - <td>Service Framework (in-process)</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - <td>Messaging</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="gray"></td> - - </tr> - <tr> - <td>Bearer Management</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - - <td>Publish and Subscribe</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - <td>Contacts</td> - - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="gray"></td> - <td bgcolor="gray"></td> - <td bgcolor="gray"></td> - </tr> - <tr> - <td>Location</td> - <td>FINAL</td> - - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - <td>Multimedia</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="gray"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - <td>System Information</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - </tr> - <tr> - <td>Sensors</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="gray"></td> - - <td bgcolor="gray"></td> - <td bgcolor="gray"></td> - <td bgcolor="gray"></td> - </tr> - <tr> - <td>Versit</td> - <td>FINAL</td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - <td bgcolor="green"></td> - - <td bgcolor="green"></td> - </tr> - <p></p> - <p></p> - </tbody> - </table> - <br> - - \endraw - - \raw HTML - <p> - \endraw - - \section1 Feedback and bug reports - Email any inquiries and feedback about Qt Mobility to qt-mobility-feedback@trolltech.com - - And please report any bugs you may find to \l {http://bugreports.qt.nokia.com} - - \section1 Acknowledgements - - The icheck tool uses the following third-party component: - - \bold {Open Source front-end for C++ (MIT license)}, Roberto Raggi <roberto.raggi@gmail.com>, QTMOBILITY/tools/icheck/parser/src -*/ - +/****************************************************************************
+**
+** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial Usage
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in a
+** written agreement between you and Nokia.
+**
+** GNU Free Documentation License
+** 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \group mobility
+ \title Qt Mobility Project APIs
+
+ Qt Mobility Project supplies a set of new APIs for Qt enabling a range of
+ mobile-centric technologies and features on mobile and non-mobile platforms.
+
+*/
+
+
+
+/*!
+ \page index.html
+ \startpage index.html Qt Reference Documentation
+
+ \title Qt Mobility Project APIs Overview
+
+ \brief An overview of the Qt Mobility Project APIs.
+
+ Qt Mobility Project delivers a set of new APIs to Qt with features
+ that are well known from the mobile device world, in particular phones.
+ However, these APIs allow the developer to use these features with ease
+ from one framework and apply them to phones, netbooks and non-mobile
+ personal computers. The framework not only improves many aspects of a
+ mobile experience, because it improves the use of these technologies,
+ but has applicability beyond the mobile device arena.
+
+ \tableofcontents
+
+
+
+ \section1 Overview
+
+ \section2 Introducing the New Qt APIs
+
+ Qt Mobility covers a wide range of features and technologies so it best
+ to regard it not as a single API but as a collection of APIs or frameworks.
+
+ This release contains the following APIs:
+
+ \annotatedlist mobility
+
+ These APIs give the developer a range of desirable functions for a
+ mobile platform, but now these functions become possible on platforms not
+ traditionally associated with some of the features. A mobile device
+ using the Qt Mobility Project API would be able to
+ \list
+ \o Locate services on-board or remotely. Find an optimal
+ connection to the network for the particular service.
+ \o Services built on top of these APIs would include Internet
+ applications such as email and web browsing.
+ \o Multimedia features enable image and video capture with audio ,
+ audio recording, and the playing of music or video clips.
+ \o Location will make the device aware of its geographical location
+ to support GIS applications.
+ \o Publish-Subscribe enables communication between separate objects
+ whether local or remote to the device.
+ \endlist
+
+ The New Qt APIs deliver to developers an enabling package. It
+ will be used by developers to build a variety of applications and
+ services that are mobile capable or familiar to mobile users,
+ irrespective of whether the platform is mobile or not. This means that
+ there is the possibility of easy transfer of user experience from PC to
+ phone or vice versa.
+
+ \section1 Namespace
+
+ The QtMobility APIs are placed into the \i{QtMobility} namespace, with
+ the important exception of Multimedia. This is done to facilitate the
+ future migration of Mobility APIs into Qt.
+
+ See the \l {Quickstart Example}{Quickstart guide} for an example on how
+ the namespace impacts on application development.
+
+ \section1 Getting Started
+ To get started with Qt Mobility see the
+ \list
+ \o \l {Installation Guide}
+ \o \l {Quickstart Example}
+ \o \l {Qt Mobility Examples}{List of all examples.}
+ \endlist
+
+ For users on the supported Symbian platforms, shown at the bottom of this
+ page, see the instructions at the
+ \l{http://library.forum.nokia.com/topic/Qt_for_Symbian_Developers_Library/GUID-7E53D0F7-72CB-41C4-8807-FE7A772B0DB4.html}{Qt For Symbian Developer's Library}
+
+ \section2 Known Issues
+ For a list of known issues and an additional details on feature supported see
+ \l {Release Notes of the QtMobility Project}.
+
+ For a overview of Platform Compatibility see \l {Platform Compatibility}.
+
+ \section1 The New Qt APIs
+ \section2 Bearer Management
+
+ Although not a network manager, this component manages the connectivity
+ state of the device to the network. So it does not manage network
+ configurations, which are the role of the platform provider, but it does
+ allow the user to start or stop network interfaces. Some higher level
+ management of the connection session may also be possible as well
+ depending on the platform.
+
+ Some platforms can have a set of grouped access points perhaps based on a
+ common purpose. Bearer Management allows comparison and prioritization
+ of the access and use of these points.
+
+ The aim of Bearer Management is to reduce the need for the developer to be
+ concerned about trying to locate the best connection from a list of
+ possible IP bearers and 3G connections. The user can select the best or
+ it can be selected transparently so that WLAN roaming can occur
+ seemlessly.
+
+ Some examples of the Bearer Management functionality,
+ \list
+ \o On demand use of the appropriate Access Point. When a user starts
+ to use a browser, the appropriate access point is selected from those
+ available and a connection is transparently made.
+ \o Always-on applications such as email or IM roam automatically
+ between cellular packet data and WLAN networks. The application developer
+ is in control and for example the application can gracefully close TCP
+ connections over the old bearer after setting up new TCP connections
+ over the new bearer.
+ \o Application developer can create a settings user interface, where
+ the user can select a certain connection to be used with the application
+ \o A connection manager application can be implemented with Qt. This
+ application enumerates available connections, shows counters, and allows
+ the user to connect or disconnect
+ \endlist
+
+ For more details, see the \l {Bearer management} {Bearer Management API overview}.
+
+ \section2 Contacts
+
+ The structure and retrieval of contact data from local or remote backends.
+ It includes the ability to create, edit, list, delete and lookup contact
+ information whether it is stored locally or remotely.
+
+ For more details, see the \l {Contacts} {Contacts API overview}.
+
+ \section2 Publish and Subscribe
+
+ Will enable context sensitive access to information in future releases.
+ Data is organized as a tree, with data being able to 'shadow' other
+ data with the 'same key', a string specifying the leaf or node. The
+ context is an example of a context ontology, a defined set of
+ relationships. As the context changes the values of the objects change
+ but the relationships remain the same. It is intended to be an enabling
+ technology, the basis of a range future applications.
+
+ At this stage the API is intended to act as a common communications
+ method between applications, whether local or remote.
+
+ For more details, see the \l {Publish and Subscribe} {Publish and Subscribe API overview}.
+
+ \section2 Location
+
+ The C++ API is one layer of this feature. This API provides an easy to
+ use interface that encapsulates basic geographical information obtained
+ from satellite or other sources about the user, including latitude and
+ longitude, bearing, speed and altitude. It will enable a range of
+ geographical applications, for example, maps.
+
+ For more details, see the \l {Location} {Location API overview}.
+
+ \section2 Messaging
+
+ A common interface for handling SMS, MMS, MIME Email and TNEF Email
+ messages. Enables access to messaging services to search and sort
+ messages, notify of changes to messages stored, send messages
+ with or without attachments, retrieve message data, and launch the
+ preferred messaging client to either display an existing message,
+ or compose a message.
+
+ For more details see the \l {Messaging} {Messaging API overview}.
+
+ \section2 Multimedia
+
+ An API to play audio and video of various formats. Record audio. The playing
+ and managing of an FM radio. This includes the typical functionality you
+ would find on a music and video player, combined with an FM radio.
+
+ For more details see the \l {Multimedia} {Multimedia API overview}.
+
+ \section2 Sensors
+
+ An API for accessing hardware sensors. This covers both high-level
+ sensors such as screen orientation (portrait, landscape) and low-level,
+ real-time sensors such as accelerometer data.
+
+ For more details see the \l{Sensors API}{Sensors API overview}.
+
+ \section2 Service Framework
+
+ A platform independent method of finding Services. A 'service' is an
+ independent component that allows a client to perform a well-defined
+ operation.
+
+ The services are implemented as plugins installed on the device and can
+ look for supporting external services running on a central server. E.g.
+ weather, local tourist attractions etc. Default applications can use
+ the layer to locate servers.
+
+ Since this is an abstraction layer then the app does not need to be
+ concerned with the underlying protocol, where the servers are, the
+ hardware peculiarities with networking and other low level details.
+
+ For more details see the \l {Qt Service Framework} {Service Framework API overview}.
+
+ \section2 System Information
+
+ An API to discover system related information and capabilities. Information
+ available will cover software version numbers, hardware features,
+ network connection types and status, display, data storage devices,
+ device information and the screensaver.
+
+ For more details see the \l {System Information} {System Information API overview}.
+
+ \section2 Versit
+
+ An API to manage Versit \reg documents, such as vCards.
+
+ For more details see the \l{Versit API}{Versit API overview}.
+
+ \section1 The QtMobility Namespace
+
+ The QtMobility APIs are placed into the QtMobility namespace. This is
+ done to facilitate the future migration of Mobility APIs into Qt. See
+ the \l {Quickstart Example}{Quickstart guide} for an example on how
+ the namespace impacts on application development.
+
+
+ \section1 Platform Compatibility
+
+
+ \raw HTML
+
+ <table cellpadding="2" cellspacing="1" border="0">
+ <tbody>
+ <tr>
+ <td>Color</td>
+ <td>Explanation</td>
+
+ </tr>
+ </tr>
+ <tr>
+ <td bgcolor="green"></td>
+ <td>A functional backend for the API on the platform is complete.</td>
+ </tr>
+ <tr>
+ <td bgcolor="yellow"></td>
+ <td>A functional backend for the API on the platform is being worked however it is not functionally complete.</td>
+
+ </tr>
+ <tr>
+ <tr>
+ <td bgcolor="lightgray"></td>
+ <td>A functional backend for the API on the platform is being worked on. At this point it is far from functionally complete or there is no platform specific code inside QDF source code.</td>
+ </tr>
+ <tr>
+ <td bgcolor="gray"></td>
+ <td>A functional backend for the API on the platform is not being worked on. It is possible for others to implement and integrate support.</td>
+ </tr>
+ </tbody>
+ </table>
+ <br>
+
+ <b>Tier 1 Platforms</b><br>
+ Primary platforms are the main focus of Mobility API. There platforms are frequently tested by our unit test suite and other internal testing tools. However, the timeline of availability for each backend is subject to change.
+ <br>
+ <b>Tier 2 Platforms</b><br>
+ Secondary platforms include future direction of Qt Mobility API. Contributions to these platforms are welcome.
+ <br>
+ <br>
+ <table align="center" cellpadding="2" cellspacing="1" border="1">
+ <tbody>
+ <tr>
+ <td rowspan="2"> </td>
+ <td rowspan="2"><b>API Maturity Level</b></td>
+ <td colspan="7" align="center" bgcolor="#96E066"><b>Tier 1 Platforms</b></td>
+ <td colspan="4" align="center" bgcolor="#96E066"><b>Tier 2 Platforms</b></td>
+ </tr>
+ <tr>
+ <td width="9%"><b>S60 3rd Edition, Feature Pack 1</b></td>
+ <td width="9%"><b>S60 3rd Edition, Feature Pack 2</b></td>
+ <td width="9%"><b>S60 5th Edition</b></td>
+ <td width="9%"><b>Symbian^3</b></td>
+ <td width="9%"><b>Maemo 5</b></td>
+ <td width="9%"><b>Windows CE/Mobile<b></b></b></td>
+ <td width="9%"><b>Windows XP/Vista</b></td>
+ <td width="9%"><b>Linux</b></td>
+ <td width="9%"><b>Mac OS X</b></td>
+ </tr>
+ <tr>
+ <td>Service Framework (in-process)</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Messaging</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Bearer Management</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Publish and Subscribe</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Contacts</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Location</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Multimedia</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>System Information</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Sensors</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Versit(vCard)</td>
+ <td>FINAL</td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Versit(iCal)</td>
+ <td>TP</td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ <td bgcolor="green"></td>
+ </tr>
+ <tr>
+ <td>Camera</td>
+ <td>TP</td>
+ <td bgcolor="lightgray"></td>
+ <td bgcolor="lightgray"></td>
+ <td bgcolor="lightgray"></td>
+ <td bgcolor="lightgray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Service Framework(OOP)</td>
+ <td>TP</td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ </tr>
+ <tr>
+ <td>Organizer</td>
+ <td>TP</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Landmarks</td>
+ <td>TP</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Document Gallery</td>
+ <td>TP</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Maps/Navigation</td>
+ <td>TP</td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="yellow"></td>
+ </tr>
+ <tr>
+ <td>Vibra</td>
+ <td>TP</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <tr>
+ <td>Telephony Events</td>
+ <td>TP</td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="yellow"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ <td bgcolor="gray"></td>
+ </tr>
+ <p></p>
+ <p></p>
+ </tbody>
+ </table>
+ <br>
+
+ \endraw
+
+ \raw HTML
+ <p>
+ \endraw
+
+ \section1 Feedback and bug reports
+ Email any inquiries and feedback about Qt Mobility to qt-mobility-feedback@trolltech.com
+
+ And please report any bugs you may find to \l {http://bugreports.qt.nokia.com}
+
+ \section1 Acknowledgements
+
+ The icheck tool uses the following third-party component:
+
+ \bold {Open Source front-end for C++ (MIT license)}, Roberto Raggi <roberto.raggi@gmail.com>, QTMOBILITY/tools/icheck/parser/src
+*/
+
diff --git a/doc/src/installation.qdoc b/doc/src/installation.qdoc index 132bfa634c..e1adb158ae 100644 --- a/doc/src/installation.qdoc +++ b/doc/src/installation.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ @@ -102,6 +88,11 @@ these domains have dependencies and these are outlined below: While not supported for this release the desktop Windows backend requires that a MAPI subsystem is installed. Note that messaging functionality will not work if you are using the MinGW compiler. + Additionally note that CE MAPI is available on Windows Mobile and + does not need to be installed separately. + + For more detailed instructions on installation on Windows Mobile + see \l {Messaging Installation On Windows Mobile} The messaging API SMS/MMS functionality requires that the platform provides SMS/MMS facilities. Email functionality requires that an email @@ -161,12 +152,18 @@ these domains have dependencies and these are outlined below: \o On all platforms, QtSystemInfo depends on QtNetwork. On Linux, it depends on QtDBus (auto-detected), HAL and \l {http://projects.gnome.org/NetworkManager/} {NetworkManager}, - although System Information will compile without them, there will be reduced functionality. It also depends on QtGui. + although System Information will compile without them, there will be reduced functionality. It also depends on QtGui, and + on libbluetooth development headers. On Mac, it depends on CoreWLAN (auto-detected) if the Mac OS X 10.6 SDK is available. It will compile with older SSDKsbut there will be reduced functionality. On Maemo, it depends on QtDBus (auto-detected). QtDBus is used to communicate with HAL, and functionality will be reduced if either is unavailable. + + On Symbian, it depends on WLANManagementAPI. WLANManagementAPI plugin is available at \l http://wiki.forum.nokia.com/index.php/SDK_API_Plug-in + For 5th edition sdk plugins are installed with installer (all at once), but for FP1 and FP2 devices a WLANManagementAPI.zip is provided. + + On Symbian, it depends on SIM Utils API SDK plugin available from Forum Nokia \l http://wiki.forum.nokia.com/index.php/File:SIMUtilsAPI_3x_50.zip \o N(Y) \o N \row diff --git a/doc/src/location.qdoc b/doc/src/location.qdoc index 366c4370ad..69ecf1a671 100644 --- a/doc/src/location.qdoc +++ b/doc/src/location.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/messaging-installation-on-windows-mobile.qdoc b/doc/src/messaging-installation-on-windows-mobile.qdoc new file mode 100644 index 0000000000..84ebd5c8b3 --- /dev/null +++ b/doc/src/messaging-installation-on-windows-mobile.qdoc @@ -0,0 +1,157 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page messaging-installation-on-windows-mobile.html + +\title Messaging Installation On Windows Mobile +\tableofcontents + +\section1 Get Qt Mobility and Qt packages + +Get the Qt Mobility Package from \l {http://get.qt.nokia.com} + +Get Qt 4.5.2 (or newer) Embedded for Windows Mobile package \l {http://get.qt.nokia.com/qt/source/qt-embedded-wince-opensource-src-4.5.3.zip} {download here}. + +\section1 Install pre-requisites + +A perl interpreter such as \l {http://www.activestate.com/activeperl} {ActivePerl} must be installed and available in the environment path. + +Visual Studio 2009 or newer must be installed. + +Windows Mobile 6 Standard SDK (including ActiveSync) must be installed \l {http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=20686a1d-97a8-4f80-bc6a-ae010e085a6e} {download page}. + +\section1 Build Qt + + Extract Qt 4.5.2 Embedded (or newer) into your Qt directory on windows. e.g. c:\\Qt\\4.5.2_winmobile6_standard + + Open a Visual Studio cmd shell + + Set your PATH to include the Qt binaries + \code + set PATH=c:\Qt\4.5.2_winmobile6_standard\bin;%PATH% + \endcode + + Set the INCLUDE and LIB vars to point to your ActiveSync sources + \code + set INCLUDE=%INCLUDE%;C:\Program Files\Windows Mobile 6 SDK\Activesync\inc + set LIB=%LIB%;C:\Program Files\Windows Mobile 6 SDK\Activesync\Lib + \endcode + + Configure Qt + \code + cd c:\Qt\4.5.2_winmobile6_standard + configure.exe -debug -platform win32-msvc2008 -xplatform wincewm60standard-msvc2008 -cetest -plugindir \qtplugins + \endcode + + Run setcepaths to setup embedded compiler paths + \code + setcepaths wincewm60standard-msvc2008 + \endcode + + Use devtools/ibmake or nmake to build. If using ibmake, ensure devtools/shell is in your path and that you have ActivePerl installed on your windows machine + \code + ibmake + \endcode + or + \code + nmake + \endcode + +\section1 Build Mobility Messaging + + Open a new Visual Studio cmd shell + + Set the path to Qt + \code + set PATH=%PATH%;c:\Qt\4.5.2_winmobile6_standard\bin + \endcode + + Set QMAKESPEC + \code + set QMAKESPEC=wincewm60standard-msvc2008 + \endcode + + Run setcepaths to set embedded compiler paths + \code + setcepaths wincewm60standard-msvc2008 + \endcode + + Run qmake and build + \code + cd <path-to-mobility-messaging-depot-or-source-package> + qmake mobility.pro + nmake + \endcode + + Visual Studio is recommended to build the mobility project for windows mobile, although it is not necessary, it makes debugging and deployment easier. + + \code + cd <path-to-mobility-messaging-depot> + qmake -tp vc QT_CONFIG+=release mobility.pro -recursive + \endcode + + If using git edit your git configuration so it does not consider Visual Studio files + + Edit <path-to-mobility-messaging-depot>/.git/info/exclude + + Append the following + \code + *.sln + *.ncb + *.suo + *.user + \endcode + + + Open the generated *.sln file and compile. + + If you get errors during the Visual Studio build regarding mainACRT, right click on the project, goto linker-advanced and Clear the Entry-Point value. + +\section1 Deploy + + Before running a debug instance, ensure that the QtMessaging.dll is a deployment dependency for the examples and tests. + + Right click properties on project e.g. serviceactions. Under deployment->addition files add: + \code + "QtMessaging.dll|$(TargetDir)|%CSIDL_PROGRAM_FILES%\serviceactions|0" + \endcode + Replacing "serviceactions" with the relevant project. diff --git a/doc/src/messaging.qdoc b/doc/src/messaging.qdoc index 72ed7256e8..0f7bebcb14 100644 --- a/doc/src/messaging.qdoc +++ b/doc/src/messaging.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc index 2046dc299d..c0aab5a34a 100644 --- a/doc/src/multimedia.qdoc +++ b/doc/src/multimedia.qdoc @@ -4,43 +4,37 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ /*! + \module QtMultimediaKit + \title QtMultimediaKit Module + \brief The QtMultimediaKit Module providees APIs to play and record media, and manage a collection of media content. + +*/ + + +/*! \group multimedia \title Mobility Multimedia APIs to play and record media, and manage a collection of media content. @@ -212,6 +206,26 @@ start, stop and various other controls. \section1 Extending the API for Symbian and Maemo + +For the developer who wishes to extend the functionality of the Multimedia +classes there are several classes of particular importance. The default +classes are QMediaService, QMediaServiceProvider and QMediaControl. + +Basically, the idea is that to use the Multimedia API you would use these three classes or classes derived from them as follows + + \list + \o \l QMediaServiceProvider is used by the top level client class to request a service. The top level class knowing what kind of service it needs. + + \o \l QMediaService provides a service and when asked by the top level object, say a component, will return a QMediaControl object. + + \o \l QMediaControl allows the control of the service using a known interface. + \endlist + +Consider a developer creating, for example, a media player class called MyPlayer. It may have special requirements beyond ordinary media players and so may need a custom service and a custom control. We can subclass \l QMediaServiceProvider to create out MyServiceProvider class. Also we will create a MyMediaService, and the MyMediaControl to manipulate the media service. + +The MyPlayer object calls MyServiceProvider::requestService() to get an instance of MyMediaService. Then the MyPlayer object calls this service object it has just received and calling \l {QMediaService::control()}{control()} it will receive the control object derived from QMediaControl. Now we have all the parts necessary for our media application. We have the service provider, the service it provides and the control used to manipulate the service. Since our MyPlayer object has instances of the service and its control then it would be possible for these to be used by associated classes that could do additional actions, perhaps with their own control since the parameter to control() is a c-type string, \i {const char *}, for the interface. + + \section2 Adding a Media Service Provider The base class for creating new service providers is \l{QMediaServiceProvider}. The user must implement the \l{QMediaServiceProvider::requestService()}{requestService()} function diff --git a/doc/src/preview.qdoc b/doc/src/preview.qdoc index 5f84fc9e01..6fe0ca1f38 100644 --- a/doc/src/preview.qdoc +++ b/doc/src/preview.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/publ-subs.qdoc b/doc/src/publ-subs.qdoc index 95722ae701..7057f284aa 100644 --- a/doc/src/publ-subs.qdoc +++ b/doc/src/publ-subs.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/qtmobility-known-issues.qdoc b/doc/src/qtmobility-known-issues.qdoc index 868285e8fa..a8bca17da5 100644 --- a/doc/src/qtmobility-known-issues.qdoc +++ b/doc/src/qtmobility-known-issues.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ @@ -141,16 +127,29 @@ Support is present for the following System Info API classes \section2 Non-API specific issues \list - \o Qt Mobility does not compile if Qt using a namespace. \o Not all example applications will display(fit) well on small screens. \o Prefixed paths in includes such as \code #include <QtLibrary/MyClass> \endcode or \code #include <QtLibrary/myclass.h> \endcode do not currently work on Symbian. \endlist +\section2 Bearer Management API +\list + \o Fremantle: Segmentation fault on removing a connected network +\endlist + +\section2 Bearer Management API +\list + \o All platforms: QNetworkConfigurationManager is not thread-safe; using it from other than main-thread off the application will not work properly. + Applies to QtMobility::QtBearer (1.0), QtBearer in Qt4.7 onwards is thread-safe. +\endlist + \section2 Contacts API \list - \o S60: Async contact operations not supported \o S60: Extending contact fields at runtime is not supported on most Symbian platforms because would compromise compatibility with the S60 platform Phonebook application. - \o S60 3.1: the Symbian contacts plugins are not loaded on a device. +\endlist + +\section2 Bearer Management API +\list + \o Fremantle: Application fail to acquire satellite signal \endlist \section2 Messaging API @@ -179,24 +178,16 @@ Support is present for the following System Info API classes \section2 Multimedia API \list + \o Fremantle: Audiorecorder fails to create file + \o Fremantle: Slideshow fails to display images \o S60: Audio capture does not support currently any special features like format, encoding etc. - \o S60: seeking is not working properly - \o S60: video size does not remain constant in repeated plays - \o S60: full screen video not working OK + \o S60, Fremantle: Full screen video not handled correctly \o S60: 3.2.3 (E75 for example) player example don't work. \o Windows desktop: wmp multimedia plugin does not display video with Windows Media Player 10 or 12 \endlist -\section2 Sensors API -\list - \o S60: The S60 sensor backends are under development and may not be complete. - \o S60 3.1: src/s60installs/s60installs.pro: the s60_sensor_api plugin for 3.1 devices is not added to the sis file when generating the sis file for multiple SDKs. -\endlist - \section2 System Info API \list - \o S60: Battery status incorrect on test applications startup. - \o S60: Phone is still charging but power state shows 100% and "wall power". - \o S60: number of bars for network reporting signal strength is hardcoded. + \o S60: Signal strength is not implemented \endlist */ diff --git a/doc/src/qtmobility.qdocconf b/doc/src/qtmobility.qdocconf index b6a3071b19..d4f26ecb42 100644 --- a/doc/src/qtmobility.qdocconf +++ b/doc/src/qtmobility.qdocconf @@ -16,7 +16,9 @@ headerdirs = ../../src/bearer \ ../../plugins/declarative/multimedia \ ../../src/messaging \ ../../src/versit \ + ../../src/telephony \ ../../src/sensors \ + ../../src/camera \ . sourcedirs = ../../src/bearer \ @@ -29,7 +31,9 @@ sourcedirs = ../../src/bearer \ ../../plugins/declarative/multimedia \ ../../src/messaging \ ../../src/versit \ + ../../src/telephony \ ../../src/sensors \ + ../../src/camera \ . excludedirs = ../../src/messaging/win32wce \ diff --git a/doc/src/sensors.qdoc b/doc/src/sensors.qdoc index bc261ec6eb..936393cf67 100644 --- a/doc/src/sensors.qdoc +++ b/doc/src/sensors.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/sf.qdoc b/doc/src/sf.qdoc index 5dcc243e26..8bc6d494fb 100644 --- a/doc/src/sf.qdoc +++ b/doc/src/sf.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ @@ -312,7 +298,9 @@ The elements and attributes have the following meanings: \o " \o capabilities \o This property is a list of arbitrary strings which are - interpreted as permissions/capabilities. This list can be empty. + interpreted as permissions/capabilities. The list elements are + comma-separated and spaces after commas are not permitted. + This list can be empty. \row \o " \o name @@ -413,7 +401,7 @@ all services that implement the interface \i com.nokia.qt.ILocation: \code QServiceManager mgr; QServiceFilter filter; - filter.setInterfaceName("com.nokia.qt.ILocation"); + filter.setInterface("com.nokia.qt.ILocation"); QList<QServiceInterfaceDescriptor> list = mgr.findInterfaces(filter); for(int i = 0; i < list.size(); i++) { QObject *serviceObject; diff --git a/doc/src/sfw_s60.qdoc b/doc/src/sfw_s60.qdoc index 07275009fa..6ff81b6824 100644 --- a/doc/src/sfw_s60.qdoc +++ b/doc/src/sfw_s60.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/si.qdoc b/doc/src/si.qdoc index 288cc412e9..5ea5594932 100644 --- a/doc/src/si.qdoc +++ b/doc/src/si.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ diff --git a/doc/src/snippets/service-snippets/filemanagerplugin.cpp b/doc/src/snippets/service-snippets/filemanagerplugin.cpp deleted file mode 100644 index a9d72e91f6..0000000000 --- a/doc/src/snippets/service-snippets/filemanagerplugin.cpp +++ /dev/null @@ -1,66 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). -** All rights reserved. -** Contact: Nokia Corporation (qt-info@nokia.com) -** -** This file is part of the Qt Mobility Components. -** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. -** -** If you have questions regarding the use of this file, please contact -** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <qserviceinterfacedescriptor.h> -#include <qabstractsecuritysession.h> -#include <qservicecontext.h> - -#include "filemanagerplugin.h" -#include "filemanagerstorage.h" -#include "filemanagertransfer.h" - -//! [createinstance-sig] -QObject* FileManagerPlugin::createInstance(const QServiceInterfaceDescriptor& descriptor, QServiceContext* context, QAbstractSecuritySession* session) -//! [createinstance-sig] -{ - Q_UNUSED(context); - Q_UNUSED(session); -//! [createinstance] - if (descriptor.interfaceName() == "com.nokia.qt.examples.FileStorage") - return new FileManagerStorage(this); - else if (descriptor.interfaceName() == "com.nokia.qt.examples.FileTransfer") - return new FileManagerTransfer(this); - else - return 0; -//! [createinstance] -} - -Q_EXPORT_PLUGIN2(serviceframework_filemanagerplugin, FileManagerPlugin) diff --git a/doc/src/telephony.qdoc b/doc/src/telephony.qdoc new file mode 100644 index 0000000000..8c51f9d090 --- /dev/null +++ b/doc/src/telephony.qdoc @@ -0,0 +1,81 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the Qt Mobility Components. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page telephony.html +\ingroup mobility + +\title Telephony API + +\brief The Telephony API enables access to the telephony event services. + +The Qt Telephony API enables access to the telephony event services to +provide telephony call notification that other applications can use to +be notified. +Using this API you can further get information abaout the status of all +existing calls. + +\tableofcontents + + +\section1 Overview + +The telephony library provides a set of function for accessing existing calls +and their information like. +Using this API you are able to queries the current telephony state. e.g. no call, ringing, +call in-progress and call on-hold. +Signals are provided to inform other application of changes of a call status. e.g. ringing, +on-hold, terminating or of a change of the list of the current existing calls. e.g. call is ending. +The Application can query call information using this API. e.g. call type, phone number, SIP id, link to the caller contact. + +\section1 Reference documentation + +\section2 Main classes + +\annotatedlist telephony + +\section1 Information and Events of Calls + +The library provides a number of classes and signals and properties to assist with the access of the calls in a mobile system. + +Another application can use this library to get informed about incomming calls, accessing calls information and more of the current system. +Basically the library provides an easy access of call information of different OS system (here it is Linux and the DBus system). + diff --git a/doc/src/versit.qdoc b/doc/src/versit.qdoc index 43b0458c0f..5e8ea39dad 100644 --- a/doc/src/versit.qdoc +++ b/doc/src/versit.qdoc @@ -4,37 +4,23 @@ ** All rights reserved. ** Contact: Nokia Corporation (qt-info@nokia.com) ** -** This file is part of the Qt Mobility Components. +** This file is part of the documentation of the Qt Toolkit. ** -** $QT_BEGIN_LICENSE:LGPL$ -** No Commercial Usage -** This file contains pre-release code and may not be distributed. -** You may use this file in accordance with the terms and conditions -** contained in the Technology Preview License Agreement accompanying -** this package. +** $QT_BEGIN_LICENSE:FDL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in a +** written agreement between you and Nokia. ** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 2.1 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 2.1 requirements -** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. -** -** In addition, as a special exception, Nokia gives you certain additional -** rights. These rights are described in the Nokia Qt LGPL Exception -** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** GNU Free Documentation License +** 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. ** ** If you have questions regarding the use of this file, please contact ** Nokia at qt-info@nokia.com. -** -** -** -** -** -** -** -** ** $QT_END_LICENSE$ ** ****************************************************************************/ |
