<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfeedbackeffect.cpp -->
<title>Qt Mobility 1.2: QFeedbackEffect Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtfeedback.html">QtFeedback</a></li>
<li>QFeedbackEffect</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QFeedbackEffect Class Reference</h1>
<!-- $$$QFeedbackEffect-brief -->
<p>The QFeedbackEffect class is the abstract base class for feedback effects. <a href="#details">More...</a></p>
<!-- @@@QFeedbackEffect -->
<pre class="cpp"> <span class="preprocessor">#include <QFeedbackEffect></span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p><b>Inherited by: </b><a href="qfeedbackfileeffect.html">QFeedbackFileEffect</a> and <a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qfeedbackeffect-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#Duration-enum">Duration</a></b> { Infinite }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#ErrorType-enum">ErrorType</a></b> { UnknownError, DeviceBusy }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#State-enum">State</a></b> { Stopped, Paused, Running, Loading }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#ThemeEffect-enum">ThemeEffect</a></b> { ThemeBasic, ThemeSensitive, ThemeBasicButton, ThemeSensitiveButton, ..., ThemeUser }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qfeedbackeffect.html#duration-prop">duration</a></b> : const int</li>
<li class="fn"><b><a href="qfeedbackeffect.html#state-prop">state</a></b> : const State</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#QFeedbackEffect">QFeedbackEffect</a></b> ( QObject * <i>parent</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#duration-prop">duration</a></b> () const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual State </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#state-prop">state</a></b> () const = 0</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#pause">pause</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#start">start</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#stop">stop</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#error">error</a></b> ( QFeedbackEffect::ErrorType <i>error</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#stateChanged">stateChanged</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#playThemeEffect">playThemeEffect</a></b> ( ThemeEffect <i>effect</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#supportsThemeEffect">supportsThemeEffect</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackeffect.html#setState">setState</a></b> ( State <i>state</i> ) = 0</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFeedbackEffect-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QFeedbackEffect class is the abstract base class for feedback effects.</p>
<p>It represents an effect to provide feedback to a person (i.e., an effect that affect human senses). The technology available today usually only provides haptic effects, which deal with the sense of touch, and audio effects. The <a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a> and <a href="qfeedbackfileeffect.html">QFeedbackFileEffect</a> are implementations of haptic effects and can be used to control a mobile device's vibrator. In addition, the <a href="qfeedbackfileeffect.html">QFeedbackFileEffect</a> can also be used to play audio feedback.</p>
<p>Feedback effects have a duration, which is measured in milliseconds. Subclasses reimplement <a href="qfeedbackeffect.html#duration-prop">duration</a>() to inform how long the effect lasts. The duration is the total time the effect will last, and thus includes any envelope modifiers (attack and fade).</p>
<p>At any given time, a feedback effect is in one of four states: Loading, Stopped, Running, or Paused. See the <a href="qfeedbackeffect.html#State-enum">State</a> enum documentation for further details. Subclasses must reimplement <a href="qfeedbackeffect.html#state-prop">state</a>() to report which state an effect is in, and <a href="qfeedbackeffect.html#setState">setState</a>() to receive state change requests. The <a href="qfeedbackeffect.html#start">start</a>(), <a href="qfeedbackeffect.html#pause">pause</a>(), and <a href="qfeedbackeffect.html#stop">stop</a>() slots calls <a href="qfeedbackeffect.html#setState">setState</a>() with the corresponding new <a href="qfeedbackeffect.html#State-enum">State</a>. Changes in state are reported through the <a href="qfeedbackeffect.html#stateChanged">stateChanged</a>() signal and may happen asynchronously some time after the state change request.</p>
<p>A system often has a set of standard feedback effects for user interface interaction (e.g., button clicks). The <a href="qfeedbackeffect.html#ThemeEffect-enum">ThemeEffect</a> describes the standard effects that QFeedbackEffect supports. It is named so because the effects often depend on the theme of the user interface. You can play these effects using the <a href="qfeedbackeffect.html#playThemeEffect">playThemeEffect</a>() function.</p>
<pre class="cpp"> <span class="type">QFeedbackEffect</span><span class="operator">::</span><a href="qfeedbackeffect.html#playThemeEffect">playThemeEffect</a>(<span class="type">QFeedbackEffect</span><span class="operator">::</span>ThemeBasicButton);</pre>
<p>The <a href="qfeedbackeffect.html#playThemeEffect">playThemeEffect</a>() function returns true if the effect was played successfully. An effect may not be played if the system does not support it or if an error occurred.</p>
</div>
<!-- @@@QFeedbackEffect -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Duration$$$Infinite -->
<h3 class="fn"><a name="Duration-enum"></a>enum QFeedbackEffect::<span class="name">Duration</span></h3>
<p>This enum describes the possible effect predefined duration types. Generally a specific milliseconds value can be supplied instead of one of these values.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::Infinite</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">Infinite effect duration</td></tr>
</table>
<!-- @@@Duration -->
<!-- $$$ErrorType$$$UnknownError$$$DeviceBusy -->
<h3 class="fn"><a name="ErrorType-enum"></a>enum QFeedbackEffect::<span class="name">ErrorType</span></h3>
<p>This enum describes the possible errors happening on the effect.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::UnknownError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">An unknown error occurred.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::DeviceBusy</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The feedback could not start because the device is busy.</td></tr>
</table>
<p><b>See also </b><a href="qfeedbackeffect.html#error">error</a>().</p>
<!-- @@@ErrorType -->
<!-- $$$State$$$Stopped$$$Paused$$$Running$$$Loading -->
<h3 class="fn"><a name="State-enum"></a>enum QFeedbackEffect::<span class="name">State</span></h3>
<p>This enum describes the state of the effect. An effect will be in one of these states.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::Stopped</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The effect is not running. This is the initial state. The state changes to either Loading when loading an effect or to Running when the effect is started by calling <a href="qfeedbackeffect.html#start">start</a>(). When an effect has finished playing, it will enter the Stopped state again.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::Paused</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The effect is paused. Calling <a href="qfeedbackeffect.html#start">start</a>() will resume it.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::Running</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The effect is running. You can control the current state by calling the <a href="qfeedbackeffect.html#stop">stop</a>() or <a href="qfeedbackeffect.html#pause">pause</a>() functions.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::Loading</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The effect is loading. That can happen when loading is done asynchronously. When the effect has loaded, the state will change to either Running (if <a href="qfeedbackeffect.html#start">start</a>() has been called) or Stopped.</td></tr>
</table>
<p><b>See also </b><a href="qfeedbackeffect.html#state-prop">state</a>().</p>
<!-- @@@State -->
<!-- $$$ThemeEffect$$$ThemeBasic$$$ThemeSensitive$$$ThemeBasicButton$$$ThemeSensitiveButton$$$ThemeBasicKeypad$$$ThemeSensitiveKeypad$$$ThemeBasicSlider$$$ThemeSensitiveSlider$$$ThemeBasicItem$$$ThemeSensitiveItem$$$ThemeItemScroll$$$ThemeItemPick$$$ThemeItemDrop$$$ThemeItemMoveOver$$$ThemeBounceEffect$$$ThemeCheckBox$$$ThemeMultipleCheckBox$$$ThemeEditor$$$ThemeTextSelection$$$ThemeBlankSelection$$$ThemeLineSelection$$$ThemeEmptyLineSelection$$$ThemePopUp$$$ThemePopupOpen$$$ThemePopupClose$$$ThemeFlick$$$ThemeStopFlick$$$ThemeMultiPointTouchActivate$$$ThemeRotateStep$$$ThemeLongPress$$$ThemePositiveTacticon$$$ThemeNeutralTacticon$$$ThemeNegativeTacticon$$$NumberOfThemeEffects$$$ThemeUser -->
<h3 class="fn"><a name="ThemeEffect-enum"></a>enum QFeedbackEffect::<span class="name">ThemeEffect</span></h3>
<p>This enum describes all possible theme effect types. In general, "sensitive" versions of effects are useful if it is less important that the effect is noticed, or when a lot of the effects are going to be played close together. Theme effects might be tactile, or audio or visual.</p>
<p>Not all platforms and devices have distinct effects for each type.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBasic</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Generic feedback.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeSensitive</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Generic sensitive feedback.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBasicButton</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Feedback for interacting with a button (e.g. pressing).</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeSensitiveButton</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Sensitive feedback for interacting with a button (e.g. auto repeat).</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBasicKeypad</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Feedback for interacting with a keypad button.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeSensitiveKeypad</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Sensitive feedback for interacting with a keypad button.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBasicSlider</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Feedback for moving a slider.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeSensitiveSlider</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">Sensitive feedback for moving a slider.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBasicItem</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Feedback when interacting with a list or grid item.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeSensitiveItem</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">Sensitive feedback when interacting with a list or grid item.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeItemScroll</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">Feedback when scrolling a list or grid item view.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeItemPick</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">Feedback when selecting an item to move in a list or grid view.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeItemDrop</tt></td><td class="topAlign"><tt>12</tt></td><td class="topAlign">Feedback when dropping an item in a list or grid view.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeItemMoveOver</tt></td><td class="topAlign"><tt>13</tt></td><td class="topAlign">Feedback when moving an item in a list or grid view.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBounceEffect</tt></td><td class="topAlign"><tt>14</tt></td><td class="topAlign">Feedback for a bounce effect.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeCheckBox</tt></td><td class="topAlign"><tt>15</tt></td><td class="topAlign">Feedback for selecting a checkbox.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeMultipleCheckBox</tt></td><td class="topAlign"><tt>16</tt></td><td class="topAlign">Feedback for selecting checkboxes of multiple items.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeEditor</tt></td><td class="topAlign"><tt>17</tt></td><td class="topAlign">Feedback for interacting with an editor.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeTextSelection</tt></td><td class="topAlign"><tt>18</tt></td><td class="topAlign">Feedback for selecting text.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeBlankSelection</tt></td><td class="topAlign"><tt>19</tt></td><td class="topAlign">Feedback for a blank selection.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeLineSelection</tt></td><td class="topAlign"><tt>20</tt></td><td class="topAlign">Feedback for selecting a line.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeEmptyLineSelection</tt></td><td class="topAlign"><tt>21</tt></td><td class="topAlign">Feedback for selecting an empty line.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemePopUp</tt></td><td class="topAlign"><tt>22</tt></td><td class="topAlign">Generic feedback for interacting with a popup.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemePopupOpen</tt></td><td class="topAlign"><tt>23</tt></td><td class="topAlign">Generic feedback when a popup opens.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemePopupClose</tt></td><td class="topAlign"><tt>24</tt></td><td class="topAlign">Generic feedback when a popup closes.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeFlick</tt></td><td class="topAlign"><tt>25</tt></td><td class="topAlign">Generic feedback when starting a flick gesture.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeStopFlick</tt></td><td class="topAlign"><tt>26</tt></td><td class="topAlign">Generic feedback when stopping a flick.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeMultiPointTouchActivate</tt></td><td class="topAlign"><tt>27</tt></td><td class="topAlign">Generic feedback when a touch gesture with more than one point is started.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeRotateStep</tt></td><td class="topAlign"><tt>28</tt></td><td class="topAlign">Feedback when rotating using a gesture.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeLongPress</tt></td><td class="topAlign"><tt>29</tt></td><td class="topAlign">Feedback for a long press (or tap and hold) gesture.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemePositiveTacticon</tt></td><td class="topAlign"><tt>30</tt></td><td class="topAlign">Generic feedback for notification of a successful operation.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeNeutralTacticon</tt></td><td class="topAlign"><tt>31</tt></td><td class="topAlign">Generic feedback for notification.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeNegativeTacticon</tt></td><td class="topAlign"><tt>32</tt></td><td class="topAlign">Generic feedback for notification of a failed operation.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::NumberOfThemeEffects</tt></td><td class="topAlign"><tt>33</tt></td><td class="topAlign">The number of built-in effects.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackEffect::ThemeUser</tt></td><td class="topAlign"><tt>65535</tt></td><td class="topAlign">The starting point for any user defined effects, where supported.</td></tr>
</table>
<!-- @@@ThemeEffect -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$duration-prop$$$duration -->
<h3 class="fn"><a name="duration-prop"></a><span class="name">duration</span> : const <span class="type">int</span></h3>
<p>This property holds duration of the feedback effect, in milliseconds.</p>
<p>In some cases the duration will be unknown, which will be reported as 0. If the duration is infinite, <a href="qfeedbackeffect.html#Duration-enum">QFeedbackEffect::Infinite</a> will be returned. Some subclasses may have more than one type of duration (for example, <a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a>), and this property will return the total duration of the effect.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> virtual int </td><td class="memItemRight bottomAlign"><span class="name"><b>duration</b></span> () const = 0</td></tr>
</table>
<!-- @@@duration -->
<!-- $$$state-prop$$$state$$$stateChanged -->
<h3 class="fn"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qfeedbackeffect.html#State-enum">State</a></span></h3>
<p>This property holds state of the feedback effect.</p>
<p>This returns the state of the feedback effect. The <a href="qfeedbackeffect.html#State-enum">State</a> enumeration reports the possible states.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> virtual State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span> () const = 0</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qfeedbackeffect.html#stateChanged">stateChanged</a></b></span> ()</td></tr>
</table>
<!-- @@@state -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QFeedbackEffect[overload1]$$$QFeedbackEffectQObject* -->
<h3 class="fn"><a name="QFeedbackEffect"></a>QFeedbackEffect::<span class="name">QFeedbackEffect</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i> = 0 )</h3>
<p>Constructs the <a href="qfeedbackeffect.html">QFeedbackEffect</a> base class, and passes <i>parent</i> to <a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>'s constructor. This is called by the classes that inherit from this class.</p>
<!-- @@@QFeedbackEffect -->
<!-- $$$error[overload1]$$$errorQFeedbackEffect::ErrorType -->
<h3 class="fn"><a name="error"></a><span class="type">void</span> QFeedbackEffect::<span class="name">error</span> ( <span class="type"><a href="qfeedbackeffect.html#ErrorType-enum">QFeedbackEffect::ErrorType</a></span> <i>error</i> ) const<tt> [signal]</tt></h3>
<p>This signal is emitted by subclasses if an <i>error</i> occurred during playback of an effect. The <a href="qfeedbackeffect.html#ErrorType-enum">ErrorType</a> enum describes the errors that can be reported.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@error -->
<!-- $$$pause[overload1]$$$pause -->
<h3 class="fn"><a name="pause"></a><span class="type">void</span> QFeedbackEffect::<span class="name">pause</span> ()<tt> [slot]</tt></h3>
<p>Pauses a playing effect. If an error occurs the <a href="qfeedbackeffect.html#error">error</a>() signal will be emitted. Not all systems support pausing an effect during playback.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@pause -->
<!-- $$$playThemeEffect[overload1]$$$playThemeEffectThemeEffect -->
<h3 class="fn"><a name="playThemeEffect"></a><span class="type">bool</span> QFeedbackEffect::<span class="name">playThemeEffect</span> ( <span class="type"><a href="qfeedbackeffect.html#ThemeEffect-enum">ThemeEffect</a></span> <i>effect</i> )<tt> [static]</tt></h3>
<p>This function plays <i>effect</i> instantly and returns true if the effect could be played; otherwise, returns false.</p>
<!-- @@@playThemeEffect -->
<!-- $$$setState[overload1]$$$setStateState -->
<h3 class="fn"><a name="setState"></a><span class="type">void</span> QFeedbackEffect::<span class="name">setState</span> ( <span class="type"><a href="qfeedbackeffect.html#State-enum">State</a></span> <i>state</i> )<tt> [pure virtual protected]</tt></h3>
<p>Requests the effect to change its State to change to the specified <i>state</i>.</p>
<p>Subclasses reimplement this function to handle state change requests for the effect.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackeffect.html#state-prop">state</a>().</p>
<!-- @@@setState -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn"><a name="start"></a><span class="type">void</span> QFeedbackEffect::<span class="name">start</span> ()<tt> [slot]</tt></h3>
<p>Starts playing the effect. If an error occurs the <a href="qfeedbackeffect.html#error">error</a>() signal will be emitted.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackeffect.html#stop">stop</a>().</p>
<!-- @@@start -->
<!-- $$$stateChanged[overload1]$$$stateChanged -->
<h3 class="fn"><a name="stateChanged"></a><span class="type">void</span> QFeedbackEffect::<span class="name">stateChanged</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted by subclasses when the <a href="qfeedbackeffect.html#State-enum">State</a> of the effect changes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackeffect.html#state-prop">state</a>().</p>
<!-- @@@stateChanged -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn"><a name="stop"></a><span class="type">void</span> QFeedbackEffect::<span class="name">stop</span> ()<tt> [slot]</tt></h3>
<p>Stops a playing effect. If an error occurs the <a href="qfeedbackeffect.html#error">error</a>() signal will be emitted.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackeffect.html#start">start</a>(), <a href="qfeedbackeffect.html#pause">pause</a>(), and <a href="qfeedbackeffect.html#setState">setState</a>().</p>
<!-- @@@stop -->
<!-- $$$supportsThemeEffect[overload1]$$$supportsThemeEffect -->
<h3 class="fn"><a name="supportsThemeEffect"></a><span class="type">bool</span> QFeedbackEffect::<span class="name">supportsThemeEffect</span> ()<tt> [static]</tt></h3>
<p>Returns true if playing themed feedback is available.</p>
<!-- @@@supportsThemeEffect -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
Free Documentation License version 1.3</a>
as published by the Free Software Foundation.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
814
