diff options
| author | Jaakko Korpela <jaakko.korpela@nokia.com> | 2012-01-19 12:14:33 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-01-20 11:15:13 +0100 |
| commit | eb5d2ca0a309bf5115669fb649af3724b4f08e3a (patch) | |
| tree | 18c336ae4a49fd1fd022c7a52f52d32c21e9f10f /doc | |
| parent | 49ca34ddbb73f721292c500c5117fe9531731f31 (diff) | |
Add documentation.
Change-Id: If84a553d3d74792eee1ccd258b57e026a6100b96
Sanity-Review: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Jaakko Korpela <jaakko.korpela@nokia.com>
Diffstat (limited to 'doc')
26 files changed, 3149 insertions, 0 deletions
diff --git a/doc/compat.qdocconf b/doc/compat.qdocconf new file mode 100644 index 0000000..0b59629 --- /dev/null +++ b/doc/compat.qdocconf @@ -0,0 +1,31 @@ +alias.i = e +alias.include = input + +macro.0 = "\\\\0" +macro.b = "\\\\b" +macro.n = "\\\\n" +macro.r = "\\\\r" +macro.i = "\\o" +macro.i11 = "\\o{1,1}" +macro.i12 = "\\o{1,2}" +macro.i13 = "\\o{1,3}" +macro.i14 = "\\o{1,4}" +macro.i15 = "\\o{1,5}" +macro.i16 = "\\o{1,6}" +macro.i17 = "\\o{1,7}" +macro.i18 = "\\o{1,8}" +macro.i19 = "\\o{1,9}" +macro.i21 = "\\o{2,1}" +macro.i31 = "\\o{3,1}" +macro.i41 = "\\o{4,1}" +macro.i51 = "\\o{5,1}" +macro.i61 = "\\o{6,1}" +macro.i71 = "\\o{7,1}" +macro.i81 = "\\o{8,1}" +macro.i91 = "\\o{9,1}" +macro.img = "\\image" +macro.endquote = "\\endquotation" +macro.relatesto = "\\relates" + +spurious = "Missing comma in .*" \ + "Missing pattern .*" diff --git a/doc/doc.pri b/doc/doc.pri new file mode 100644 index 0000000..459e9ba --- /dev/null +++ b/doc/doc.pri @@ -0,0 +1,14 @@ +OTHER_FILES += \ + $$PWD/qt5.qdocconf \ + $$PWD/qt5-dita.qdocconf + +docs_target.target = docs +docs_target.commands = qdoc3 $$PWD/qt5.qdocconf + +ditadocs_target.target = ditadocs +ditadocs_target.commands = qdoc3 $$PWD/qt5-dita.qdocconf + +QMAKE_EXTRA_TARGETS = docs_target ditadocs_target +QMAKE_CLEAN += \ + "-r $$PWD/html" \ + "-r $$PWD/ditaxml" diff --git a/doc/macros.qdocconf b/doc/macros.qdocconf new file mode 100644 index 0000000..ca458c1 --- /dev/null +++ b/doc/macros.qdocconf @@ -0,0 +1,43 @@ +macro.aacute.HTML = "á" +macro.Aring.HTML = "Å" +macro.aring.HTML = "å" +macro.Auml.HTML = "Ä" +macro.author = "\\bold{Author:}" +macro.br.HTML = "<br />" +macro.BR.HTML = "<br />" +macro.copyright.HTML = "©" +macro.eacute.HTML = "é" +macro.gui = "\\bold" +macro.hr.HTML = "<hr />" +macro.iacute.HTML = "í" +macro.key = "\\bold" +macro.menu = "\\bold" +macro.note = "\\bold{Note:}" +macro.oslash.HTML = "ø" +macro.ouml.HTML = "ö" +macro.QA = "Qt Assistant" +macro.QC = "Creator" +macro.QD = "Qt Designer" +macro.QL = "Qt Linguist" +macro.QMLD = "Qt Quick Designer" +macro.QQV = "Qt QML Viewer" +macro.QSDK = "Qt SDK" +#macro.qtcversion = $QTC_VERSION +macro.qtcversion = "0.0" +macro.param = "\\e" +macro.raisedaster.HTML = "<sup>*</sup>" +macro.rarrow.HTML = "→" +macro.reg.HTML = "<sup>®</sup>" +macro.return = "Returns" +macro.starslash = "\\c{*/}" +macro.begincomment = "\\c{/*}" +macro.endcomment = "\\c{*/}" +macro.uuml.HTML = "ü" +macro.mdash.HTML = "—" +macro.pi.HTML = "Π" + +macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" +macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" +macro.endfloat.HTML = "</div>" +macro.clearfloat.HTML = "<br style=\"clear: both\" />" +macro.emptyspan.HTML = "<span></span>" diff --git a/doc/qt-cpp-ignore.qdocconf b/doc/qt-cpp-ignore.qdocconf new file mode 100644 index 0000000..8591b26 --- /dev/null +++ b/doc/qt-cpp-ignore.qdocconf @@ -0,0 +1,100 @@ +Cpp.ignoretokens = QAXFACTORY_EXPORT \ + QDESIGNER_COMPONENTS_LIBRARY \ + QDESIGNER_EXTENSION_LIBRARY \ + QDESIGNER_SDK_LIBRARY \ + QDESIGNER_SHARED_LIBRARY \ + QDESIGNER_UILIB_LIBRARY \ + QM_EXPORT_CANVAS \ + QM_EXPORT_DNS \ + QM_EXPORT_DOM \ + QM_EXPORT_FTP \ + QM_EXPORT_HTTP \ + QM_EXPORT_ICONVIEW \ + QM_EXPORT_NETWORK \ + QM_EXPORT_OPENGL \ + QM_EXPORT_OPENVG \ + QM_EXPORT_SQL \ + QM_EXPORT_TABLE \ + QM_EXPORT_WORKSPACE \ + QM_EXPORT_XML \ + QT_ASCII_CAST_WARN \ + QT_ASCII_CAST_WARN_CONSTRUCTOR \ + QT_BEGIN_HEADER \ + QT_DESIGNER_STATIC \ + QT_END_HEADER \ + QT_FASTCALL \ + QT_WIDGET_PLUGIN_EXPORT \ + Q_COMPAT_EXPORT \ + Q_CORE_EXPORT \ + Q_CORE_EXPORT_INLINE \ + Q_EXPLICIT \ + Q_EXPORT \ + Q_EXPORT_CODECS_CN \ + Q_EXPORT_CODECS_JP \ + Q_EXPORT_CODECS_KR \ + Q_EXPORT_PLUGIN \ + Q_GFX_INLINE \ + Q_AUTOTEST_EXPORT \ + Q_GUI_EXPORT \ + Q_GUI_EXPORT_INLINE \ + Q_GUI_EXPORT_STYLE_CDE \ + Q_GUI_EXPORT_STYLE_COMPACT \ + Q_GUI_EXPORT_STYLE_MAC \ + Q_GUI_EXPORT_STYLE_MOTIF \ + Q_GUI_EXPORT_STYLE_MOTIFPLUS \ + Q_GUI_EXPORT_STYLE_PLATINUM \ + Q_GUI_EXPORT_STYLE_POCKETPC \ + Q_GUI_EXPORT_STYLE_SGI \ + Q_GUI_EXPORT_STYLE_WINDOWS \ + Q_GUI_EXPORT_STYLE_WINDOWSXP \ + QHELP_EXPORT \ + Q_INLINE_TEMPLATE \ + Q_INTERNAL_WIN_NO_THROW \ + Q_LOCATION_EXPORT \ + Q_NETWORK_EXPORT \ + Q_OPENGL_EXPORT \ + Q_OPENVG_EXPORT \ + Q_OUTOFLINE_TEMPLATE \ + Q_SQL_EXPORT \ + Q_SVG_EXPORT \ + Q_SCRIPT_EXPORT \ + Q_SCRIPTTOOLS_EXPORT \ + Q_TESTLIB_EXPORT \ + Q_TYPENAME \ + Q_XML_EXPORT \ + Q_XMLSTREAM_EXPORT \ + Q_XMLPATTERNS_EXPORT \ + QDBUS_EXPORT \ + Q_DBUS_EXPORT \ + QT_BEGIN_NAMESPACE \ + QT_BEGIN_INCLUDE_NAMESPACE \ + QT_END_NAMESPACE \ + QT_END_INCLUDE_NAMESPACE \ + PHONON_EXPORT \ + Q_DECLARATIVE_EXPORT \ + Q_GADGET \ + QWEBKIT_EXPORT \ + Q_INVOKABLE \ + Q_DECL_CONSTEXPR +Cpp.ignoredirectives = Q_DECLARE_HANDLE \ + Q_DECLARE_INTERFACE \ + Q_DECLARE_METATYPE \ + Q_DECLARE_OPERATORS_FOR_FLAGS \ + Q_DECLARE_PRIVATE \ + Q_DECLARE_PUBLIC \ + Q_DECLARE_SHARED \ + Q_DECLARE_TR_FUNCTIONS \ + Q_DECLARE_TYPEINFO \ + Q_DISABLE_COPY \ + QT_FORWARD_DECLARE_CLASS \ + Q_DUMMY_COMPARISON_OPERATOR \ + Q_ENUMS \ + Q_FLAGS \ + Q_INTERFACES \ + __attribute__ \ + K_DECLARE_PRIVATE \ + PHONON_OBJECT \ + PHONON_HEIR \ + Q_PRIVATE_PROPERTY \ + Q_DECLARE_PRIVATE_D \ + Q_CLASSINFO diff --git a/doc/qt-defines.qdocconf b/doc/qt-defines.qdocconf new file mode 100644 index 0000000..aaf935a --- /dev/null +++ b/doc/qt-defines.qdocconf @@ -0,0 +1,18 @@ +defines = Q_QDOC \ + QT_.*_SUPPORT \ + QT_.*_LIB \ + QT_COMPAT \ + QT_KEYPAD_NAVIGATION \ + QT_NO_EGL \ + QT3_SUPPORT \ + Q_WS_.* \ + Q_OS_.* \ + Q_BYTE_ORDER \ + QT_DEPRECATED \ + Q_NO_USING_KEYWORD \ + __cplusplus \ + Q_COMPILER_INITIALIZER_LISTS + +versionsym = QT_VERSION_STR + +codeindent = 1 diff --git a/doc/qt5-dita.qdocconf b/doc/qt5-dita.qdocconf new file mode 100644 index 0000000..129a455 --- /dev/null +++ b/doc/qt5-dita.qdocconf @@ -0,0 +1,27 @@ +# Name of the project. +project = projectname + +include(macros.qdocconf) +include(compat.qdocconf) +include(qt-cpp-ignore.qdocconf) +include(qt-defines.qdocconf) + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. +exampledirs += . +headerdirs += .. +sourcedirs += .. +imagedirs += images + + +#Do not change the variables after this line unless you know what you are doing. + +outputdir = ditaxml +outputformats = DITAXML + +sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" +headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" diff --git a/doc/qt5.qdocconf b/doc/qt5.qdocconf new file mode 100644 index 0000000..3c1aff2 --- /dev/null +++ b/doc/qt5.qdocconf @@ -0,0 +1,75 @@ +# Name of the project. +project = projectname + +include(macros.qdocconf) +include(compat.qdocconf) +include(qt-cpp-ignore.qdocconf) +include(qt-defines.qdocconf) + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. +exampledirs += .. +headerdirs += .. +imagedirs += images +sourcedirs += .. + +# The following parameters are for creating a qhp file, the qhelpgenerator +# program can convert the qhp file into a qch file which can be opened in +# Qt Assistant and/or Qt Creator. + +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp.<projectname>.property +# format. +qhp.projects = projectname + +# Sets the name of the output qhp file. +qhp.projectname.file = projectname.qhp + +# Namespace for the output file. This namespace is used to distinguish between +# different documentation files in Creator/Assistant. Normal format for MP +# projects should be: com.nokia.mp.<projectname>.version with version being +# a number containing a major, minor and revision element. E.g. version 1.0 +# becomes 100. +qhp.projectname.namespace = com.nokia.mp.projectname.100 + +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.projectname.indexTitle = Projectname Documentation + +# Extra files to add to the output which are not linked to from anywhere +# using a qdoc \l command. +qhp.projectname.extraFiles = style/style.css \ + index.html + +# Only updtae the name of the project for the next variables. +qhp.projectname.virtualFolder = qdoc +qhp.projectname.subprojects = classes +qhp.projectname.subprojects.classes.title = Classes +qhp.projectname.subprojects.classes.selectors = class fake:headerfile +qhp.projectname.subprojects.classes.sortPages = true + + + +# Do NOT change the variables after this line unless you know what you are doing. + +outputdir = html +outputformats = HTML + +examples.fileextensions = "*.cpp *.h *.js *.svg *.xml *.ui *.qml" +examples.imageextensions = "*.png *.jpeg *.jpg *.gif *.mng" +headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx" +sources.fileextensions = "*.cpp *.qdoc *.mm *.qml" + +HTML.nobreadcrumbs = "true" + +HTML.templatedir = . +HTML.stylesheets = style/style.css + +HTML.headerstyles = " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/style.css\" />\n" +HTML.endheader = "</head>\n<body>\n" + +HTML.footer = "<div class=\"footer\">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>\n" diff --git a/doc/src/examples/hapticsplayer.qdoc b/doc/src/examples/hapticsplayer.qdoc new file mode 100644 index 0000000..feb9e38 --- /dev/null +++ b/doc/src/examples/hapticsplayer.qdoc @@ -0,0 +1,73 @@ +/**************************************************************************** +** +** 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$ +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example hapticsplayer + \title Haptics Player + + \tableofcontents + + \section1 Overview + + This example shows how to use various haptic effects in an application via + the \l{Feedback}{Qt Feedback API}. + + It provides an example of how to use the QtMobility libraries to: + \list + \o play "system theme" haptic effects corresponding to certain predefined events + \o play a dynamic custom effect, single or repeating + \o play a custom effect which is stored in a file + \endlist + + \section2 Use Case + + This example is more feature complete than the \l{hapticsquare}{Haptic Square} example, + but is intended more as a way to test the haptics provider plugins which + are available on a system, than as an example for application developers. + + It is useful for people who wish to learn how to use the API to create and + play custom effects dynamically, or to allow users of an application to + select which haptic effect to play when a particular event occurs. It is also useful + to test how effects are implemented on specific devices. + + It is a more complex example than the \l{hapticsquare}{Haptic Square} example, so it is + suggested that developers look at that example first. + + \section2 Interface + The application is designed to work on desktop and mobile platforms with + minimal differences in code between the platforms. The interface consists + of three tabs which allow the user to select and play different custom, + system theme, and file effects, respectively. The custom effect tab also + allows the user to modify the custom effect dynamically, and see the effect + of attack and fade, intensity and duration, and periodicity, on the user + experience. + + \section2 Known Issues + The example will not work correctly on platforms which do not have a + QFeedbackHapticInterface (haptic effect provider) plugin loaded. On such + platforms, the example will do nothing. +*/ diff --git a/doc/src/examples/hapticsquare.qdoc b/doc/src/examples/hapticsquare.qdoc new file mode 100644 index 0000000..fdd712b --- /dev/null +++ b/doc/src/examples/hapticsquare.qdoc @@ -0,0 +1,169 @@ +/**************************************************************************** +** +** 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$ +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example hapticsquare + \title Haptic Square Example + + \section1 Overview + + This example shows how to use simple haptic effects in an application via + the \l{Feedback}{Qt Feedback API}. + + It provides an example of how to use the Qt Feedback + \list + \o play "system theme" haptic effects corresponding to certain predefined events + \o play a custom effect, single or repeating + \endlist + + \section2 Use Case + + Compelling applications attempt to immerse the user in the application + experience. There are many elements to an immersive experience, including + a consistent and beautiful graphical user interface design, unobtrusive yet + informative sound design, and intuitive program flow. Another important + aspect of immersive applications is tactile feedback and haptic effects. + + The \l{Feedback}{QtFeedback API} allows application developers to + include tactile feedback into their application via a simple to use and + extensible API. Some common uses for tactile feedback are: + + \list + \o maintain consistency with system theme for tactile feedback about interface events (button clicks, scrolling, etc) + \o notify the user of an application-specific event (invalid operation, status change, etc) + \o multisensory user interface (status can be "read" by touching the screen, tactile interfaces, etc) + \o immersive gaming experiences (explosions, impacts, collisions, etc) + \endlist + + This example application provides some short snippets which illustrate how + the first two of those use cases may be fulfilled. + + \section1 The Application + + The application is designed to work on desktop and mobile platforms with + minimal differences in code between the platforms. The interface consists + of four buttons arranged into a square, each of which causes a different + tactile effect to be played by the default tactile effect provider plugin + on the platform. + + \image hapticsquare-example.png + + \list + \o "Rumble!" plays a non-repeating effect with symmetric attack and decay + \o "Ocean" is a toggle button which plays a repeating ocean wave-like effect + \o "Click" plays the system theme effect for a basic button click + \o "Oops!" plays the system theme effect for a negative or invalid response + \endlist + + The example implements two classes: + + \list + \o \c {HapticButton}: Implementation of a button. It + inherits QWidget and sends signals for button clicks. + \o \c {Dialog}: A QDialog subclass that displays the four + \c{HapticButton}s mentioned above, + connects them to its slots, and implements the functionality to + play the haptic effects. + \endlist + + \section2 The Dialog Class + + We will now go through the code for the \c Dialog class. Here is its + definition: + + \snippet examples/hapticsquare/hapticsquare.h 0 + + The buttons are connected to the slots, which play the effects. We will now + go through the implementation of \c Dialog. + + The constructor starts by setting up the non-repeating haptic effect, which + is played by clicking the \gui {Rumble! Button}. + + \snippet examples/hapticsquare/hapticsquare.cpp 0 + + Custom haptics effects are created by setting up a QFeedbackHapticsEffect. + + A haptics effect provides a fade-in of the effect's + \l{QFeedbackHapticsEffect::}{intensity()}. With vibration, you can think of + the intensity as how hard the device will vibrate. The effect will start at + \l{QFeedbackHapticsEffect::}{attackIntensity()} and interpolate to + \l{QFeedbackHapticsEffect::}{intensity()} in + \l{QFeedbackHapticsEffect::}{attackTime()} milliseconds. When the effect + ends, we have a similar fade-out, where the haptics effect's intensity will + interpolate from \l{QFeedbackHapticsEffect::}{intensity()} to + \l{QFeedbackHapticsEffect::}{fadeTime()} in + \l{QFeedbackHapticsEffect::}{fadeTime()} milliseconds. + The effect will last for a total duration of + \l{QFeedbackHapticsEffect::}{duration()} milliseconds. + + We next set up the effect for the \gui {Ocean Button}. + + \snippet examples/hapticsquare/hapticsquare.cpp 1 + + The \c m_ocean is a periodic effect, i.e., it repeats after + \l{QFeedbackHapticsEffect::}{period()} milliseconds. Note that the + \l{QFeedbackHapticsEffect::}{duration()} must be greater than the period + in order for the periodicity of the effect to be discernable. + + We then set up the GUI and connects the buttons to slots that will play the + effects. + + \snippet examples/hapticsquare/hapticsquare.cpp 2 + + Let's look at the slots to see how the effects are played. + + \snippet examples/hapticsquare/hapticsquare.cpp 3 + + With the \c m_rumble, we only have to call \l{QFeedbackEffect::}{start()}. It + will stop when the effect has finished, and can be played again by calling + \l{QFeedbackEffect::}{start()} again. + + The periodic \c m_ocean effect is started the same way as the \c m_rumble + effect, and may be stopped with the \l{QFeedbackEffect::}{stop()} function. + It will start playing from the beginning again when + \l{QFeedbackEffect::}{start()} is called. We could also have paused the + effect with \l{QFeedbackEffect::}{pause()}. + + \snippet examples/hapticsquare/hapticsquare.cpp 4 + + System theme effects are played with the static + QFeedbackEffect::playThemeEffect() function. Theme effects cannot be stopped + or paused. There is no guarantee that the backend can play the effect; + \l{QFeedbackEffect::}{playThemeEffect()} will return false if the effect + could not be played. + + \section1 Known Issues + + The example is not intended to exercise the entire API. Instead, it is a + simple example which illustrates some simple uses of the API. + Also, the example will not work correctly on platforms which do not have a + QFeedbackHapticInterface (haptic effect provider) plugin loaded. On such + platforms, clicking the buttons will have no effect. On Maemo5, periodic + effects do not support attack or fade, and so the ocean effect is not + smooth. +*/ + diff --git a/doc/src/images/hapticsquare-example.png b/doc/src/images/hapticsquare-example.png Binary files differnew file mode 100644 index 0000000..8664c24 --- /dev/null +++ b/doc/src/images/hapticsquare-example.png diff --git a/doc/src/images/non-periodic-effect.png b/doc/src/images/non-periodic-effect.png Binary files differnew file mode 100644 index 0000000..5f2dfb1 --- /dev/null +++ b/doc/src/images/non-periodic-effect.png diff --git a/doc/src/images/non-periodic-effect.svg b/doc/src/images/non-periodic-effect.svg new file mode 100644 index 0000000..77350c5 --- /dev/null +++ b/doc/src/images/non-periodic-effect.svg @@ -0,0 +1,396 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + sodipodi:version="0.32" + inkscape:version="0.46" + sodipodi:docname="non-periodic-effect.svg" + inkscape:output_extension="org.inkscape.output.svg.inkscape" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="95.105827" + inkscape:export-ydpi="95.105827"> + <defs + id="defs4"> + <marker + inkscape:stockid="Arrow2Mstart" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Mstart" + style="overflow:visible"> + <path + id="path3184" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(0.6) translate(0,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Sstart" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow1Sstart" + style="overflow:visible"> + <path + id="path3172" + d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z " + style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;marker-start:none" + transform="scale(0.2) translate(6,0)" /> + </marker> + <marker + inkscape:stockid="Arrow2Lend" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Lend" + style="overflow:visible;"> + <path + id="path3181" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(1.1) rotate(180) translate(1,0)" /> + </marker> + <marker + inkscape:stockid="Arrow2Mend" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Mend" + style="overflow:visible;"> + <path + id="path3187" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(0.6) rotate(180) translate(0,0)" /> + </marker> + <inkscape:perspective + sodipodi:type="inkscape:persp3d" + inkscape:vp_x="0 : 526.18109 : 1" + inkscape:vp_y="0 : 1000 : 0" + inkscape:vp_z="744.09448 : 526.18109 : 1" + inkscape:persp3d-origin="372.04724 : 350.78739 : 1" + id="perspective10" /> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + gridtolerance="10000" + guidetolerance="10" + objecttolerance="10" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="164.10579" + inkscape:cy="909.32435" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="true" + inkscape:window-width="1254" + inkscape:window-height="930" + inkscape:window-x="70" + inkscape:window-y="144"> + <inkscape:grid + type="xygrid" + id="grid2383" + visible="true" + enabled="true" + units="pt" + spacingx="1pt" + spacingy="1pt" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <rect + style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:1.25000000000000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect9765" + width="493.75" + height="312.5" + x="37.5" + y="52.362183" /> + <path + style="fill:none;fill-opacity:0.75000000000000000;fill-rule:evenodd;stroke:#000000;stroke-width:2.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none;marker-end:url(#Arrow2Mend)" + d="M 75,327.36218 L 75,77.362183" + id="path2385" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75000000000000000;fill-rule:evenodd;stroke:#000000;stroke-width:2.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none;marker-end:url(#Arrow2Mend)" + d="M 75,327.36218 L 450,327.36218" + id="path3935" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,127.36218 L 62.5,127.36218" + id="path4981" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,202.36218 L 62.5,202.36218" + id="path4983" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,277.36218 L 62.5,277.36218 L 62.5,277.36218" + id="path4985" + sodipodi:nodetypes="ccc" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 125,327.36218 L 125,339.86218" + id="path4987" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 362.5,327.36218 L 362.5,339.86218" + id="path4989" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 125,327.36218 L 125,202.36218 L 175,127.36218 L 312.5,127.36218 L 362.5,277.36218 L 362.5,327.36218" + id="path4991" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 175,327.36218 L 175,339.86218" + id="path4993" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 312.5,327.36218 L 312.5,339.86218" + id="path4995" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="140.76465" + y="344.9772" + id="text7664" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7666" + x="140.76465" + y="344.9772">AT</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="327.65967" + y="344.96521" + id="text7668" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7670" + x="327.65967" + y="344.96521">FT</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="111" + y="349.36218" + id="text7672" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7674" + x="111" + y="349.36218">t</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="362.5" + y="352.36218" + id="text7676" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7678" + x="362.5" + y="352.36218">q</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="41.410156" + y="282.46521" + id="text7680" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7682" + x="41.410156" + y="282.46521">FI</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="41" + y="207.46521" + id="text7684" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7686" + x="41" + y="207.46521">AI</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="51.117188" + y="132.46521" + id="text7688" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7690" + x="51.117188" + y="132.46521">I</tspan></text> + <g + id="g9295" + transform="translate(0,1.1996025e-2)" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"> + <path + sodipodi:nodetypes="ccc" + id="path4997" + d="M 162.5,339.86218 L 175,339.86218 L 175,339.86218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 125,339.86218 L 137.5,339.86218 L 137.5,339.86218" + id="path8227" + sodipodi:nodetypes="ccc" /> + </g> + <g + transform="translate(187.5,2.6171874e-6)" + id="g9299" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 162.5,339.86218 L 175,339.86218 L 175,339.86218" + id="path9301" + sodipodi:nodetypes="ccc" /> + <path + sodipodi:nodetypes="ccc" + id="path9303" + d="M 125,339.86218 L 137.5,339.86218 L 137.5,339.86218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + </g> + <path + sodipodi:nodetypes="ccc" + id="path9307" + d="M 281.25,358.61218 L 362.5,358.61218 L 362.5,358.61218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 125,358.61218 L 137.5,358.61218 L 206.25,358.61218" + id="path9309" + sodipodi:nodetypes="ccc" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <text + xml:space="preserve" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + x="213.24463" + y="363.09781" + id="text9313" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan9315" + x="213.24463" + y="363.09781">Duration</tspan></text> + <text + sodipodi:linespacing="125%" + id="text9323" + y="332.5574" + x="456.25" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + xml:space="preserve" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + y="332.5574" + x="456.25" + id="tspan9325" + sodipodi:role="line">Time (ms)</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + x="43.75" + y="71.112183" + id="text9327" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan9329" + x="43.75" + y="71.112183">Intensity</tspan></text> + </g> +</svg> diff --git a/doc/src/images/periodic-effect.png b/doc/src/images/periodic-effect.png Binary files differnew file mode 100644 index 0000000..8b11284 --- /dev/null +++ b/doc/src/images/periodic-effect.png diff --git a/doc/src/images/periodic-effect.svg b/doc/src/images/periodic-effect.svg new file mode 100644 index 0000000..9b92cc6 --- /dev/null +++ b/doc/src/images/periodic-effect.svg @@ -0,0 +1,431 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + width="744.09448819" + height="1052.3622047" + id="svg2" + sodipodi:version="0.32" + inkscape:version="0.46" + sodipodi:docname="periodic-effect.svg" + inkscape:output_extension="org.inkscape.output.svg.inkscape" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/periodic-effect.png" + inkscape:export-xdpi="95.105827" + inkscape:export-ydpi="95.105827"> + <defs + id="defs4"> + <marker + inkscape:stockid="Arrow2Mstart" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Mstart" + style="overflow:visible"> + <path + id="path3184" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(0.6) translate(0,0)" /> + </marker> + <marker + inkscape:stockid="Arrow1Sstart" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow1Sstart" + style="overflow:visible"> + <path + id="path3172" + d="M 0.0,0.0 L 5.0,-5.0 L -12.5,0.0 L 5.0,5.0 L 0.0,0.0 z " + style="fill-rule:evenodd;stroke:#000000;stroke-width:1.0pt;marker-start:none" + transform="scale(0.2) translate(6,0)" /> + </marker> + <marker + inkscape:stockid="Arrow2Lend" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Lend" + style="overflow:visible;"> + <path + id="path3181" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(1.1) rotate(180) translate(1,0)" /> + </marker> + <marker + inkscape:stockid="Arrow2Mend" + orient="auto" + refY="0.0" + refX="0.0" + id="Arrow2Mend" + style="overflow:visible;"> + <path + id="path3187" + style="font-size:12.0;fill-rule:evenodd;stroke-width:0.62500000;stroke-linejoin:round;" + d="M 8.7185878,4.0337352 L -2.2072895,0.016013256 L 8.7185884,-4.0017078 C 6.9730900,-1.6296469 6.9831476,1.6157441 8.7185878,4.0337352 z " + transform="scale(0.6) rotate(180) translate(0,0)" /> + </marker> + <inkscape:perspective + sodipodi:type="inkscape:persp3d" + inkscape:vp_x="0 : 526.18109 : 1" + inkscape:vp_y="0 : 1000 : 0" + inkscape:vp_z="744.09448 : 526.18109 : 1" + inkscape:persp3d-origin="372.04724 : 350.78739 : 1" + id="perspective10" /> + </defs> + <sodipodi:namedview + id="base" + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1.0" + gridtolerance="10000" + guidetolerance="10" + objecttolerance="10" + inkscape:pageopacity="1" + inkscape:pageshadow="2" + inkscape:zoom="1.4142136" + inkscape:cx="295.35578" + inkscape:cy="909.32435" + inkscape:document-units="px" + inkscape:current-layer="layer1" + showgrid="true" + inkscape:window-width="1254" + inkscape:window-height="930" + inkscape:window-x="70" + inkscape:window-y="144"> + <inkscape:grid + type="xygrid" + id="grid2383" + visible="true" + enabled="true" + units="pt" + spacingx="1pt" + spacingy="1pt" /> + </sodipodi:namedview> + <metadata + id="metadata7"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + </cc:Work> + </rdf:RDF> + </metadata> + <g + inkscape:label="Layer 1" + inkscape:groupmode="layer" + id="layer1"> + <rect + style="opacity:1;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:1.25000000000000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" + id="rect10300" + width="625" + height="337.5" + x="37.5" + y="52.362183" /> + <path + style="fill:none;fill-opacity:0.75000000000000000;fill-rule:evenodd;stroke:#000000;stroke-width:2.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;stroke-miterlimit:4;stroke-dasharray:none;marker-end:url(#Arrow2Mend)" + d="M 75,327.36218 L 75,77.362183" + id="path2385" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:2.5;stroke-linecap:butt;stroke-linejoin:miter;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 75,327.58502 L 581.25,327.36218" + id="path3935" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" + sodipodi:nodetypes="cc" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,127.36218 L 62.5,127.36218" + id="path4981" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,202.36218 L 62.5,202.36218" + id="path4983" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 75,277.36218 L 62.5,277.36218 L 62.5,277.36218" + id="path4985" + sodipodi:nodetypes="ccc" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 125,327.36218 L 125,339.86218" + id="path4987" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 281.25,327.36218 L 281.25,339.86218" + id="path4989" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 125,327.36218 L 125,202.36218 L 175,127.36218 L 231.25,127.36218 L 281.25,277.36218 L 281.25,202.36218 L 331.25,127.36218 L 387.5,127.36218 L 437.5,277.36218 L 437.5,202.36218 L 487.5,127.36218 L 543.75,127.36218 L 543.75,327.36218" + id="path4991" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" + sodipodi:nodetypes="ccccccccccccc" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 175,327.36218 L 175,339.86218" + id="path4993" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + d="M 231.25,327.36218 L 231.25,339.86218" + id="path4995" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="140.76465" + y="344.9772" + id="text7664" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7666" + x="140.76465" + y="344.9772">AT</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="246.40967" + y="344.96521" + id="text7668" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7670" + x="246.40967" + y="344.96521">FT</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="111" + y="349.36218" + id="text7672" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7674" + x="111" + y="349.36218">t</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="543.75" + y="352.36218" + id="text7676" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7678" + x="543.75" + y="352.36218">q</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="41.410156" + y="282.46521" + id="text7680" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7682" + x="41.410156" + y="282.46521">FI</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="41" + y="207.46521" + id="text7684" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7686" + x="41" + y="207.46521">AI</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Serif;-inkscape-font-specification:DejaVu Serif Italic" + x="51.117188" + y="132.46521" + id="text7688" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan7690" + x="51.117188" + y="132.46521">I</tspan></text> + <g + id="g9295" + transform="translate(0,1.1996025e-2)" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"> + <path + sodipodi:nodetypes="ccc" + id="path4997" + d="M 162.5,339.86218 L 175,339.86218 L 175,339.86218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 125,339.86218 L 137.5,339.86218 L 137.5,339.86218" + id="path8227" + sodipodi:nodetypes="ccc" /> + </g> + <g + transform="translate(106.25,2.6171874e-6)" + id="g9299" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 162.5,339.86218 L 175,339.86218 L 175,339.86218" + id="path9301" + sodipodi:nodetypes="ccc" /> + <path + sodipodi:nodetypes="ccc" + id="path9303" + d="M 125,339.86218 L 137.5,339.86218 L 137.5,339.86218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" /> + </g> + <path + sodipodi:nodetypes="ccc" + id="path9307" + d="M 231.25,358.61218 L 281.25,358.61218 L 281.25,358.61218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 125,358.61218 L 175,358.61218" + id="path9309" + sodipodi:nodetypes="cc" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <text + xml:space="preserve" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + x="181.25" + y="363.8194" + id="text9313" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan9315" + x="181.25" + y="363.8194">Period</tspan></text> + <text + sodipodi:linespacing="125%" + id="text9323" + y="332.56314" + x="587.5" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + xml:space="preserve" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + y="332.56314" + x="587.5" + id="tspan9325" + sodipodi:role="line">Time (ms)</tspan></text> + <text + xml:space="preserve" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + x="43.75" + y="71.112183" + id="text9327" + sodipodi:linespacing="125%" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782"><tspan + sodipodi:role="line" + id="tspan9329" + x="43.75" + y="71.112183">Intensity</tspan></text> + <g + id="g9363"> + <path + sodipodi:nodetypes="ccc" + id="path9355" + d="M 368.75,377.36218 L 543.75,377.36218 L 543.75,377.36218" + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:none;marker-end:url(#Arrow2Mend);stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + <path + style="fill:none;fill-opacity:0.75;fill-rule:evenodd;stroke:#000000;stroke-width:1.25;stroke-linecap:butt;stroke-linejoin:miter;marker-start:url(#Arrow2Mstart);marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 125,377.36218 L 300,377.36218" + id="path9357" + sodipodi:nodetypes="cc" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + inkscape:export-xdpi="71.923782" + inkscape:export-ydpi="71.923782" /> + </g> + <text + inkscape:export-ydpi="71.923782" + inkscape:export-xdpi="71.923782" + inkscape:export-filename="/home/dboddie/git/qtmobility/doc/src/images/non-periodic-effect.png" + sodipodi:linespacing="125%" + id="text9359" + y="381.84781" + x="303.86963" + style="font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;font-family:DejaVu Sans;-inkscape-font-specification:DejaVu Sans" + xml:space="preserve"><tspan + y="381.84781" + x="303.86963" + id="tspan9361" + sodipodi:role="line">Duration</tspan></text> + </g> +</svg> diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc new file mode 100644 index 0000000..cb168f0 --- /dev/null +++ b/doc/src/index.qdoc @@ -0,0 +1,204 @@ +/**************************************************************************** +** +** 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$ +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\page index.html +\title Feedback + +\brief An API enabling a client to provide tactile and audio feedback to user actions. + +\ingroup mobility + +The Feedback API enables a client to control and provide tactile and audio feedback +to the user. The feedback is in response to user actions. For example, touching an +onscreen button. Control of the feedback involves control of the vibration of +the device, when a vibrator is used, or the piezo feedback from the screen. + + +\tableofcontents + + + +\section1 Overview + +The Feedback API allows application developers to implement feedback and programmatic vibration +in their applications. The API provides abstractions for various types of +feedback, and allows custom implementations of these types of feedback. + +The QFeedbackEffect class provides a simple interface to allow developers to +start, stop or pause the playback of an effect. It is an abstract class which +is implemented by QFeedbackHapticsEffect and QFeedbackFileEffect. In addition, +it allows the instantaneous playback of feedback effects which match the system +theme. + +A QFeedbackHapticsEffect is a custom effect which allows a program to play a +haptic effect on an actuator. Such an effect might have a duration, intensity, +and envelope of playback (including attack time and intensity, and fade time +and intensity), as well as a period if it is a periodic (repeating) effect. + +A QFeedbackFileEffect is a haptic tune or audio file saved in a file which may be played +back. These effects must be created by third-party applications, and a plugin +which supports the specific file format must be installed. In particular, note that +audio effects are generally limited to simple formats, to reduce latency. You can +check what formats are supported by the system by calling QFeedbackFileEffect::supportedMimeTypes(). + +For the vast majority of use cases, the QFeedbackEffect, QFeedbackHapticsEffect +and QFeedbackFileEffect classes are the only classes which developers will use +in their programs. There are some special cases, however, where they may wish +to implement their own feedback plugin. The QtFeedback API allows +third party developers to implement QFeedbackInterface in a plugin which may be +loaded by the plugin loading mechanism to play feedback effects. + +Note that in any application, only the highest priority plugin for each of the +three types of feedback will be used to provide the feedback effects, except +for file feedback plugins (where only the highest priority plugin for each +supported mime-type is used). The interface classes which must be implemented +by a plugin to provide effects to clients are: +\list + \o \l{QFeedbackHapticsInterface} for \l{QFeedbackHapticsEffect} + \o \l{QFeedbackFileInterface} for \l{QFeedbackFileEffect} + \o \l{QFeedbackThemeInterface} for the built-in theme effects (\l{QFeedbackEffect::ThemeEffect}). +\endlist + +Generally, the device platform will provide an implementation of each of the +three different interfaces, which will be the default plugins used for the +various \l {QFeedbackEffect}s. + +\section2 Platform Issues + +\note On Symbian, vibration feature needs to be enabled in the user profile for the API to work. +\note On Maemo5, periodic vibration does not support attack or fade. + +\section1 Using Effects + +\section2 Theme Effects + +The most common use of the API is to play system theme effects for user +interface interaction notifications, for example, button clicks. These +system theme effects can be played instantaneously, but cannot be paused or +stopped. They are played via the static QFeedbackEffect::playThemeEffect() +function: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Play the system theme button click effect + +There are many different theme effects defined, to cover a variety of +interactions and notifications, to allow an application to maintain greater +consistency with the platform user experience. +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Play the system theme bounce effect + +\section2 Custom Effects + +The next most common use of the API is to define a custom effect which can be +used to notify the user of application-specific events or to increase the +immersiveness of an application. A custom effect may be either periodic or +non-periodic. + +The following diagram shows the graph of intensity over time of a non-periodic +effect which was started at time \c t and ended at time \c q, with an +\l{QFeedbackHapticsEffect::intensity()}{intensity} of \c{I}, an +\l{QFeedbackHapticsEffect::attackIntensity()}{attack intensity} of \c{AI}, a +\l{QFeedbackHapticsEffect::fadeIntensity()}{fade intensity} of \c{FI}, an +\l{QFeedbackHapticsEffect::attackTime()}{attack time} of \c{AT}, and a +\l{QFeedbackHapticsEffect::fadeTime()}{fade time} of \c{FT}, with a total +\l{QFeedbackEffect::duration()}{duration} of \c{Duration} milliseconds: + +\image non-periodic-effect.png + +The following diagram shows the graph of intensity over time of a periodic +effect which was started at time \c t and ended at time \c q, with an +\l{QFeedbackHapticsEffect::intensity()}{intensity} of \c{I}, an +\l{QFeedbackHapticsEffect::attackIntensity()}{attack intensity} of \c{AI}, a +\l{QFeedbackHapticsEffect::fadeIntensity()}{fade intensity} of \c{FI}, an +\l{QFeedbackHapticsEffect::attackTime()}{attack time} of \c{AT}, and a +\l{QFeedbackHapticsEffect::fadeTime()}{fade time} of \c{FT}, with a +\l{QFeedbackHapticsEffect::period()}{period} of \c{Period} milliseconds and a total +\l{QFeedbackEffect::duration()}{duration} of \c{Duration} milliseconds: + +\image periodic-effect.png + +A custom haptic effect may be defined in the following manner: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Define a custom haptic effect +\note No periodicity was defined for the effect, although that can be done +by calling QFeedbackHapticsEffect::setPeriod() if required. + +Once the effect has been defined, it may be played via the API offered in the +QFeedbackEffect base class: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Start playing a custom haptic effect + +Custom haptic effects are stateful, and so they may be paused: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Pause a custom haptic effect + +Or stopped: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Stop playing a custom haptic effect + +Certain operations cannot be performed on an effect if it is in a certain +state. The current state of the effect may be queried via the base-class API: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Query the state of a custom haptic effect + +All custom effects are played using a specific +\l{QFeedbackActuator}{device actuator}. By default, the effect is played via +the actuator which the current haptic effect provider plugin considers to be +the system default actuator, and so most application developers will not need +to change which actuator is used. In some cases, however, it may be desirable +to set which actuator the effect is played on; doing so requires prior +knowledge of either the name or the id of the actuator on which the developer +wishes the effect to be played: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Set the actuator which should play the custom effect + +Finally, there is software available which allows "haptic tunes" to be saved to +file, for later playback. If the haptic file effect provider plugin on the +system understands that file format, the file can be played on device: +\snippet doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp Play a haptic effect from a file +In addition, small audio effects can be played as feedback. + +If you wish to see a simple example application which demonstrates some of +the above code in use, please see the \l{hapticsquare}{Haptic Square} example +application. + +\section1 Main Classes +\list + \o \l{QFeedbackEffect} + \o \l{QFeedbackHapticsEffect} + \o \l{QFeedbackFileEffect} + \o \l{QFeedbackActuator} + \o \l{QFeedbackInterface} +\endlist + +\section1 Examples +\list + \o \l{hapticsquare}{Haptic Square} + \o \l{hapticsplayer}{Haptics Player} +\endlist + +\section1 QML Elements + +For details on the QML support provided for the Feedback API see the documentation for the \l {Feedback QML Plugin}. + + + +*/ + diff --git a/doc/src/legal/3rdparty.qdoc b/doc/src/legal/3rdparty.qdoc new file mode 100644 index 0000000..e2c8bb7 --- /dev/null +++ b/doc/src/legal/3rdparty.qdoc @@ -0,0 +1,300 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page 3rdparty.html + + \title Third-Party Licenses Used in Qt + \ingroup licensing + \brief License information for third-party libraries supplied with Qt. + + Qt includes a number of third-party libraries that are used to provide + certain features. Unlike the code described in the + \l{Other Licenses Used in Qt}{code used in Qt} document, these + libraries are supplied alongside the Qt modules. + + Third Party Software may impose additional restrictions and it is the + user's responsibility to ensure that they have met the licensing + requirements of the GPL, LGPL, or Qt Commercial license and the relevant + license of the Third Party Software they are using. + + Run \c{configure -help} to see any options that may be available for + controlling the use of these libraries. + + \tableofcontents + + \section1 DES (\c des.cpp) + + \i{Implementation of DES encryption for NTLM\br + Copyright 1997-2005 Simon Tatham.\br + This software is released under the MIT license.} + + See \c src/3rdparty/des/des.cpp for more information about the terms and + conditions under which the code is supplied. + + \section1 FreeType 2 (\c freetype) version 2.3.6 + + \i{The FreeType project is a team of volunteers who develop free, portable + and high-quality software solutions for digital typography. We specifically + target embedded systems and focus on bringing small, efficient and + ubiquitous products.} -- quoted from \c 3rdparty/freetype/docs/freetype2.html. + + See \c src/3rdparty/freetype/docs/FTL.txt and \c + src/3rdparty/freetype/docs/GPL.txt for license details. + + See also the files in \c src/3rdparty/harfbuzz, which are used by + FreeType. + + Parts of the FreeType projects have been modified and put into Qt + for use in the painting subsystem. These files are ftraster.h, + ftraster.c, ftgrays.h and ftgrays.c. The following modifications + has been made to these files: + + \list + \o Renamed FT_ and ft_ symbols to QT_FT_ and qt_ft_ to avoid name + conflicts. + \o Removed parts of code not relevant when compiled with + _STANDALONE_ defined. + \o Changed behavior in ftraster.c to follow X polygon filling + rules. + \o Implemented support in ftraster.c for winding / odd even + polygon fill rules. + \o Replaced bitmap generation with span generation in ftraster.c + \o Renamed: ftraster.h to qblackraster_p.h + \o Renamed: ftraster.c to qblackraster.c + \o Renamed: ftgrays.h to qgrayraster_p.h + \o Renamed: ftgrays.c to qgrayraster.c + \endlist + + \section1 HarfBuzz (\c harfbuzz) + + \i{This is HarfBuzz, an OpenType Layout engine.} + + \i{It was derived originally from the OpenType code in FreeType-1.x, ported to + FreeType2. (This code has been abandoned for FreeType2, but until something + better comes along, should serve our purposes.) In addition to porting to + FreeType-2, it has been modified in various other ways.} -- quoted from + \c src/3rdparty/harfbuzz/README. + + See \c src/3rdparty/harfbuzz/COPYING.FTL and src/3rdparty/harfbuzz/COPYING.GPL + for license details. + + \section1 The Independent JPEG Group's JPEG Software (\c libjpeg) version 6b + + \i{This package contains C software to implement JPEG image compression and + decompression. JPEG (pronounced "jay-peg") is a standardized compression + method for full-color and gray-scale images. JPEG is intended for compressing + "real-world" scenes; line drawings, cartoons and other non-realistic images + are not its strong suit. JPEG is lossy, meaning that the output image is not + exactly identical to the input image.} -- quoted from \c + src/3rdparty/libjpeg/README. + + See \c src/3rdparty/libjpeg/README for license details. + + \section1 MD4 (\c md4.cpp and \c md4.h) + + \i{MD4 (RFC-1320) message digest.\br + Modified from MD5 code by Andrey Panin <pazke@donpac.ru>\br\br + Written by Solar Designer <solar@openwall.com> in 2001, and placed in\br + the public domain. There's absolutely no warranty.} + + See \c src/3rdparty/md4/md4.cpp and \c src/3rdparty/md4/md4.h for more + information about the terms and conditions under which the code is + supplied. + + \section1 MD5 (\c md5.cpp and \c md5.h) + + \i{This code implements the MD5 message-digest algorithm. + The algorithm is due to Ron Rivest. This code was + written by Colin Plumb in 1993, no copyright is claimed. + This code is in the public domain; do with it what you wish.} -- quoted from + \c src/3rdparty/md5/md5.h + + See \c src/3rdparty/md5/md5.cpp and \c src/3rdparty/md5/md5.h for more + information about the terms and conditions under which the code is + supplied. + + \section1 MNG Library (\c libmng) version 1.0.10 + + \i{The libmng library supports decoding, displaying, encoding, and various + other manipulations of the Multiple-image Network Graphics (MNG) format + image files. It uses the zlib compression library, and optionally the + JPEG library by the Independant JPEG Group (IJG) and/or + lcms (little cms), a color-management library by Marti Maria Saguer.} + -- quoted from \c src/3rdparty/libmng/doc/libmng.txt + + See \c src/3rdparty/libmng/LICENSE for license details. + + \section1 PNG Reference Library (\c libpng) version 1.2.29 + + \i{Libpng was written as a companion to the PNG specification, as a way + of reducing the amount of time and effort it takes to support the PNG + file format in application programs.} -- quoted from \c + src/3rdparty/libpng/libpng.txt. + + See \c src/3rdparty/libpng/LICENSE for license details. + + \section1 The ptmalloc memory allocator (\c ptmalloc3) version 1.8 + + \i ptmcalloc3 is a scalable concurrent memory allocator suitable + for use in multi-threaded programs. + + \hr + + Copyright (c) 2001-2006 Wolfram Gloger + + Permission to use, copy, modify, distribute, and sell this software + and its documentation for any purpose is hereby granted without fee, + provided that (i) the above copyright notices and this permission + notice appear in all copies of the software and related documentation, + and (ii) the name of Wolfram Gloger may not be used in any advertising + or publicity relating to the software. + + THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, + EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + + IN NO EVENT SHALL WOLFRAM GLOGER BE LIABLE FOR ANY SPECIAL, + INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY + DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, + WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY + OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR + PERFORMANCE OF THIS SOFTWARE. + + \hr + + See \c src/3rdparty/ptmalloc/COPYRIGHT for license details. + + \section1 SHA-1 (\c sha1.cpp) + + \i{Based on the public domain implementation of the SHA-1 algorithm\br + Copyright (C) Dominik Reichl <dominik.reichl@t-online.de>} + + See \c src/3rdparty/sha1/sha1.cpp for more information about the terms and + conditions under which the code is supplied. + + \section1 SQLite (\c sqlite) version 3.5.9 + + \i{SQLite is a small C library that implements a + self-contained, embeddable, zero-configuration SQL database engine.} + -- quoted from \l{http://www.sqlite.org/}{www.sqlite.org}. + + According to the comments in the source files, the code is in the public + domain. See the + \l{http://www.sqlite.org/copyright.html}{SQLite Copyright} page on the + SQLite web site for further information. + + \section1 TIFF Software Distribution (\c libtiff) version 3.8.2 + + \i {libtiff is a set of C functions (a library) that support the + manipulation of TIFF image files.} -- quoted from \c + src/libtiff/html/libtiff.html + + \hr + + Copyright (c) 1988-1997 Sam Leffler\br + Copyright (c) 1991-1997 Silicon Graphics, Inc.\br + Copyright (C) 2004, Andrey Kiselev <dron@ak4719.spb.edu>\br + Copyright (c) 1997 Greg Ward Larson + + Permission to use, copy, modify, distribute, and sell this software and + its documentation for any purpose is hereby granted without fee, provided + that (i) the above copyright notices and this permission notice appear in + all copies of the software and related documentation, and (ii) the names of + Sam Leffler and Silicon Graphics may not be used in any advertising or + publicity relating to the software without the specific, prior written + permission of Sam Leffler and Silicon Graphics. + + THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, + EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + + IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR + ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, + OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, + WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + OF THIS SOFTWARE. + + \hr + + Copyright (c) 1996-1997 Sam Leffler\br + Copyright (c) 1996 Pixar + + Permission to use, copy, modify, distribute, and sell this software and + its documentation for any purpose is hereby granted without fee, provided + that (i) the above copyright notices and this permission notice appear in + all copies of the software and related documentation, and (ii) the names of + Pixar, Sam Leffler and Silicon Graphics may not be used in any advertising or + publicity relating to the software without the specific, prior written + permission of Pixar, Sam Leffler and Silicon Graphics. + + THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, + EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY + WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + + IN NO EVENT SHALL PIXAR, SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR + ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, + OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, + WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF + LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + OF THIS SOFTWARE. + + \hr + + See \c src/3rdparty/libtiff/COPYRIGHT for license details. + + \section1 Wintab API (\c wintab) + + Wintab is a de facto API for pointing devices on Windows. The + wintab code is from \l{http://www.pointing.com/WINTAB.HTM}. + + See \c src/3rdparty/wintab/wintab.h for license details. + + \section1 Data Compression Library (\c zlib) version 1.2.3 + + \i{zlib is a general purpose data compression library. All the code + is thread safe. The data format used by the zlib library is described + by RFCs (Request for Comments) 1950 to 1952} -- quoted from \c + src/3rdparty/zlib/README. + + See \c src/3rdparty/zlib/README for license details. +*/ diff --git a/doc/src/legal/editions.qdoc b/doc/src/legal/editions.qdoc new file mode 100644 index 0000000..7c1f76a --- /dev/null +++ b/doc/src/legal/editions.qdoc @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page editions.html + \title Qt Editions + \ingroup licensing + \brief Information about the different editions of Qt. + + Qt can be used to create both commercial and non-commercial + software for a wide range of different deployment environments, + and is supplied in a number of different forms to suit the needs + of different kinds of developers. + + In terms of license conditions, there are two main forms of Qt: + + \list + \o The \l{Qt Commercial Edition} are the commercial + versions of \l{About Qt}{Qt}. + \o The \l{Open Source Versions of Qt} are freely available for download. + \endlist + + On the Qt web site, you can find a + \l{Qt Licensing Overview} and information on \l{Qt License Pricing} + for commercial editions of Qt and other Qt-related products. +*/ diff --git a/doc/src/legal/gpl.qdoc b/doc/src/legal/gpl.qdoc new file mode 100644 index 0000000..a314a2e --- /dev/null +++ b/doc/src/legal/gpl.qdoc @@ -0,0 +1,67 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! \page lgpl.html +\title GNU Lesser General Public License (LGPL) +\ingroup licensing +\brief About the LGPL license used for Qt. + +The Qt GUI Toolkit is Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).\br +Contact: Nokia Corporation (qt-info@nokia.com) + +Qt is available under the LGPL. + +\section1 The GNU Lesser General Public License (Version 2.1) + +Reference: \l{GNU Lesser General Public License, version 2.1} + +\snippet doc/src/snippets/code/doc_src_lgpl.qdoc LGPL v2.1 + +\section1 Nokia Qt LGPL Exception version 1.0 + +As a special exception to the GNU Lesser General Public License version 2.1, +the object code form of a "work that uses the Library" may incorporate material +from a header file that is part of the Library. You may distribute such object +code under terms of your choice, provided that the incorporated material +(i) does not exceed more than 5% of the total size of the Library; and +(ii) is limited to numerical parameters, data structure layouts, accessors, +macros, inline functions and templates. +*/ diff --git a/doc/src/legal/opensourceedition.qdoc b/doc/src/legal/opensourceedition.qdoc new file mode 100644 index 0000000..fd97022 --- /dev/null +++ b/doc/src/legal/opensourceedition.qdoc @@ -0,0 +1,91 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page opensourceedition.html + + \title Open Source Versions of Qt + \ingroup licensing + \brief Information about the license and features of the Open Source Edition. + + Free (or open source) software is software that comes with a license + that gives users certain rights. In particular the right to use the + software, to modify it, to obtain its source, and to pass it on (under + the same terms). Notice that the term "free" is about rights, not + money. The Free Software Foundation (creators of the GNU GPL) speaks + of free in this context as in "free speech", not as in "no cost". + + Nokia supports the free software concept by providing the Qt Open Source + Edition, which is licensed under the \l{GNU General Public License (GPL)} + (version 3) and the \l{GNU Lesser General Public License (LGPL)} (version 2.1). + You can use this edition of Qt to create and distribute software with licenses + that are compatible to these free software licenses. + + The support of open source with the Open Source Versions of Qt has enabled large + successful software projects like KDE to thrive, with thousands of developers + around the world using open source versions of Qt at no cost to themselves. With + the release of Qt 4, open source versions of Qt became available for Unix/X11, + Mac OS X, and Windows platforms. + + The Open Source Edition can be downloaded from the \l{Downloads}{Qt website}. + + Please refer to the online \l{License FAQ} for answers to frequently asked + questions on open source licensing and its implications. + + More information on Free and Open Source software is available online: + + \list + \o GNU GPL: \l http://www.gnu.org/. + \o Open Source licensing: \l http://www.opensource.org/. + \endlist + + See \l{Licensing Information} for a collection of documents about licenses + used in Qt. + + Information about Qt Commercial License Agreements is available + in the \l{Qt Licensing Overview} on the Qt website or by contacting + the sales department at http://qt.nokia.com/contact. + + If you are in doubt what edition of Qt is right for your project, + please contact + \l{mailto:qt-info@nokia.com}{qt-info@nokia.com}. + +*/ diff --git a/doc/src/legal/trademarks.qdoc b/doc/src/legal/trademarks.qdoc new file mode 100644 index 0000000..fe2acc3 --- /dev/null +++ b/doc/src/legal/trademarks.qdoc @@ -0,0 +1,77 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page trademarks.html + + \title Trademarks + \ingroup licensing + \brief Information about trademarks owned by Nokia and other organisations. + + Nokia, the Nokia logo, Qt, and the Qt logo are trademarks of Nokia \reg + Corporation and/or its subsidiaries in Finland and other countries. + + \list + \o Intel, Intel Inside (logos), MMX and Pentium are \reg trademarks of + Intel Corporation in the United States, other countries, or both. + \o Java and all Java-based trademarks are trademarks of Sun Microsystems, + Inc. in the United States, other countries, or both. + \o Linux is a \reg trademark of Linus Torvalds in the United States, other + countries or both. + \o Mac, Mac OS and Macintosh are \reg trademarks of Apple Computer, Inc., + registered in the U.S. and other countries. + \o Microsoft, Windows, Windows NT, XP, Visual Studio and the Windows logo + are \reg trademarks of Microsoft Corporation in the United States, other + countries, or both. + \o Motif is a registered trademark of The Open Group in the United States, + other countries, or both. + \o OpenGL is a \reg trademark of Silicon Graphics, Inc. in the United States + and other countries. + \o UNIX is a registered trademark of The Open Group in the United States + and other countries. + \o Versit is a \reg trademark of the Internet Mail Consortium in the United States + and other countries. + \o All other company, product, or service names may be trademarks or + service marks of others and are the property of their respective owners. + The use of the word partner does not imply a partnership relationship + between Nokia and any other company. + \endlist +*/ diff --git a/doc/src/plugins/qml-feedback.qdoc b/doc/src/plugins/qml-feedback.qdoc new file mode 100644 index 0000000..79960a4 --- /dev/null +++ b/doc/src/plugins/qml-feedback.qdoc @@ -0,0 +1,62 @@ +/**************************************************************************** +** +** 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$ +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \group qml-feedback + \title QML Feedback Plugin + QML Support for the Qt Feedback API. + +*/ + + +/*! + \page qml-feedback-api.html + + \title Feedback QML Plugin + + \brief A QML plugin for the QtFeedback API. + + + + \section1 Overview + + The API provides abstractions for various types of feedback, and allows custom implementations of these types of feedback. + The identifying string for this component is \i {"QtMobility.feedback"}. + + + The Feedback API allows application developers to implement feedback and programmatic vibration in their applications. + Use this in the QML \i {import} statement. + + + + \section1 Feedback elements + + \annotatedlist qml-feedback-api + +*/ + + diff --git a/doc/src/snippets/code/doc_src_lgpl.qdoc b/doc/src/snippets/code/doc_src_lgpl.qdoc new file mode 100644 index 0000000..39d55a8 --- /dev/null +++ b/doc/src/snippets/code/doc_src_lgpl.qdoc @@ -0,0 +1,548 @@ +/**************************************************************************** +** +** 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:LGPL$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [LGPL v2.1] + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + + +//! [LGPL v2.1] diff --git a/doc/src/snippets/declarative/declarative-feedback.qml b/doc/src/snippets/declarative/declarative-feedback.qml new file mode 100644 index 0000000..ccc6e28 --- /dev/null +++ b/doc/src/snippets/declarative/declarative-feedback.qml @@ -0,0 +1,97 @@ +/**************************************************************************** +** +** 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:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor +** the names of its contributors may be used to endorse or promote +** products derived from this software without specific prior written +** permission. +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** $QT_END_LICENSE$ +** +****************************************************************************/ + +import QtQuick 2.0 +import Qt.feedback 5.0 + +Rectangle { + id: page + width: 800 + height: 350 + color: "olive" + + //![File Effect] + FileEffect { + id: myFileEffect + loaded: false + source: "file:///myfile.ivs" + } + + MouseArea { + onClicked: myFileEffect.start(); + } + + //![File Effect] + + //![Haptics Effect] + HapticsEffect { + id: rumbleEffect + attackIntensity: 0.0 + attackTime: 250 + intensity: 1.0 + duration: 100 + fadeTime: 250 + fadeIntensity: 0.0 + } + MouseArea { + onClicked: { + rumbleEffect.start(); // plays a rumble effect + } + + //![Haptics Effect] + + //![Theme] + // My custom button + MouseArea { + Image { /* ... Pretty graphics here ... */ } + onClicked: ThemeEffect {effect: ThemeEffect.BasicButton;} + } + + ThemeEffect { + id: myOtherThemeEffect + effect: "RotateStep" + } + + MouseArea { + onClicked: myOtherThemeEffect.play(); + } + + //![Theme] +} diff --git a/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp b/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp new file mode 100644 index 0000000..9bc32fb --- /dev/null +++ b/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.cpp @@ -0,0 +1,104 @@ +/**************************************************************************** +** +** 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$ +** GNU Lesser General Public License Usage +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <qfeedbackactuator.h> +#include <qfeedbackeffect.h> + +#include <QDebug> + + +void completeExample(); + +void completeExample() +{ +//! [Play the system theme button click effect] + QFeedbackEffect::playThemeEffect(QFeedbackEffect::ThemeBasicButton); +//! [Play the system theme button click effect] + +//! [Play the system theme bounce effect] + QFeedbackEffect::playThemeEffect(QFeedbackEffect::ThemeBounceEffect); +//! [Play the system theme bounce effect] + +//! [Define a custom haptic effect] + QFeedbackHapticsEffect rumble; + rumble.setAttackIntensity(0.0); + rumble.setAttackTime(250); + rumble.setIntensity(1.0); + rumble.setDuration(1000); + rumble.setFadeTime(250); + rumble.setFadeIntensity(0.0); +//! [Define a custom haptic effect] + +//! [Start playing a custom haptic effect] + rumble.start(); +//! [Start playing a custom haptic effect] + +//! [Pause a custom haptic effect] + rumble.pause(); +//! [Pause a custom haptic effect] + +//! [Stop playing a custom haptic effect] + rumble.stop(); +//! [Stop playing a custom haptic effect] + +//! [Query the state of a custom haptic effect] + if (rumble.state() == QFeedbackEffect::Stopped) + qDebug() << "The device has stopped rumbling!"; +//! [Query the state of a custom haptic effect] + +//! [Set the actuator which should play the custom effect] + QFeedbackActuator *actuator = 0; // default system actuator + QList<QFeedbackActuator*> actuators = QFeedbackActuator::actuators(); + foreach (QFeedbackActuator* temp, actuators) { + if (temp->name() == "ExampleActuatorName") { + actuator = temp; + } + } + rumble.setActuator(actuator); +//! [Set the actuator which should play the custom effect] + +//! [Play a haptic effect from a file] + QFeedbackFileEffect hapticTune; + hapticTune.setSource(QUrl::fromLocalFile("mySavedRumble.ifr")); + hapticTune.load(); + hapticTune.start(); +//! [Play a haptic effect from a file] +} diff --git a/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.pro b/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.pro new file mode 100644 index 0000000..e4ad857 --- /dev/null +++ b/doc/src/snippets/qtfeedbackdocsample/qtfeedbackdocsample.pro @@ -0,0 +1,21 @@ +###################################################################### +# +# Simple example of how to use the feedback API +# +###################################################################### + +TEMPLATE = lib +TARGET = qtfeedbackdocsample +include(../../../../features/basic_examples_setup.pri) +INCLUDEPATH += ../../../../src/global \ + ../../../../src/feedback + +CONFIG += mobility +MOBILITY = feedback + +SOURCES += qtfeedbackdocsample.cpp + +symbian { + TARGET.EPOCALLOWDLLDATA = 1 + MMP_RULES+="EXPORTUNFROZEN" +} diff --git a/doc/style/style.css b/doc/style/style.css new file mode 100644 index 0000000..df84049 --- /dev/null +++ b/doc/style/style.css @@ -0,0 +1,137 @@ +a:link, a:visited { + color: #00732F; + text-decoration: none; + font-weight: bold; +} + +body { + font: normal 400 14px/1.2 Arial; + margin-top: 85px; +} + +h1 { + margin: 0; +} + +h2 { + font: 500 20px/1.2 Arial; +} + +h3.fn, span.fn { + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background-color: #F6F6F6; + border-width: 1px; + border-style: solid; + border-color: #E6E6E6; + word-spacing: 3px; + padding: 3px 5px; +} + +table, pre { + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background-color: #F6F6F6; + border: 1px solid #E6E6E6; + border-collapse: separate; + font-size: 12px; + line-height: 1.2; + margin-bottom: 25px; + margin-left: 15px; +} + +table td { + padding: 3px 15px 3px 20px; +} + +table tr.even { + background-color: white; + color: #66666E; +} + +table tr.odd { + background-color: #F6F6F6; + color: #66666E; +} + +li { + margin-bottom: 10px; + padding-left: 12px; +} + +.cpp { + display: block; + margin: 10; + overflow: hidden; + overflow-x: hidden; + overflow-y: hidden; + padding: 20px 0 20px 0; +} + +.footer { + margin-top: 50px; +} + +.memItemLeft { + padding-right: 3px; +} + +.memItemRight { + padding: 3px 15px 3px 0; +} + +.qml { + display: block; + margin: 10; + overflow: hidden; + overflow-x: hidden; + overflow-y: hidden; + padding: 20px 0 20px 0; +} + +.qmldefault { + padding-left: 5px; + float: right; + color: red; +} + +.qmlreadonly { + padding-left: 5px; + float: right; + color: #254117; +} + +.rightAlign { + padding: 3px 5px 3px 10px; + text-align: right; +} + +.title { + background-color: white; + color: #44A51C; + font-family: Verdana; + font-size: 35px; + font-weight: normal; + left: 0; + padding-bottom: 5px; + padding-left: 16px; + padding-top: 20px; + position: absolute; + right: 0; + top: 0; +} + +.toc { + float: right; + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background-color: #F6F6F6; + border: 1px solid #DDD; + margin: 0 20px 10px 10px; + padding: 20px 15px 20px 20px; + height: auto; + width: 200px; +} |
