<?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" />
<!-- qdeclarativefeedbackeffect.cpp -->
<title>Qt Mobility 1.2: QML FeedbackEffect Element</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="http://qt.nokia.com/doc/4.7/qdeclarativeelements.html">QML Elements</a></li>
<li>QML FeedbackEffect Element</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QML FeedbackEffect Element</h1>
<span class="subtitle"></span>
<!-- $$$FeedbackEffect-brief -->
<p>The FeedbackEffect element is the base class for all feedback effects. <a href="#details">More...</a></p>
<!-- @@@FeedbackEffect -->
<p>Inherited by <a href="qml-fileeffect.html">FileEffect</a> and <a href="qml-hapticseffect.html">HapticsEffect</a>.</p>
<p>This element was introduced in Mobility 1.1.</p>
<ul>
<li><a href="qml-feedbackeffect-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-feedbackeffect.html#duration-prop">duration</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-feedbackeffect.html#error-prop">error</a></b></b> : Feedback::ErrorType</li>
<li class="fn"><b><b><a href="qml-feedbackeffect.html#paused-prop">paused</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-feedbackeffect.html#running-prop">running</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-feedbackeffect.html#state-prop">state</a></b></b> : FeedbackEffect::State</li>
</ul>
<!-- $$$FeedbackEffect-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>This element is part of the <b>QtMobility.feedback 1.1</b> module.</p>
<p>You can't create one of these elements directly, but several other elements inherit the methods and properties of these elements.</p>
<p>There are several predefined enumerations and constants provided in this class:</p>
<p>1. Duration This enum describes the possible predefined duration types. Generally a specific value in milliseconds can be supplied instead of one of these values.</p>
<ul>
<li>Feedback.Infinite - Infinite effect duration</li>
</ul>
<p>2. State This enum describes the state of the effect. An effect will be in one of these states.</p>
<ul>
<li>Feedback.stopped - The effect is not running. This is the initial state.</li>
<li>Feedback.paused - The effect is paused.</li>
<li>Feedback.running - The effect is running.</li>
<li>Feedback.loading - The effect is loading.</li>
</ul>
<p>3. ErrorType This enum describes the possible errors happening on the effect.</p>
<ul>
<li>Feedback.UnknownError - An unknown error occurred.</li>
<li>Feedback.DeviceBusy - The feedback could not start because the device is busy, the device could be busy if a higher-priority client is using the haptics/actuator device.</li>
</ul>
<p><b>See also </b><a href="qml-fileeffect.html">FileEffect</a>, <a href="qml-themeeffect.html">ThemeEffect</a>, <a href="qml-hapticseffect.html">HapticsEffect</a>, and <a href="qfeedbackeffect.html">QFeedbackEffect</a>.</p>
<!-- @@@FeedbackEffect -->
<h2>Property Documentation</h2>
<!-- $$$duration -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="duration-prop"></a><span class="name">duration</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-int.html">int</a></span></p></td></tr></table></div><div class="qmldoc"><p>The duration of the effect, in milliseconds. This is 0 for effects of unknown duration, or Feedback.Infinite for effects that don't stop.</p>
<p>This property group was introduced in Mobility 1.1.</p>
<p><b>See also </b><a href="feedback.html">Feedback</a>.</p>
</div></div><!-- @@@duration -->
<br/>
<!-- $$$error -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="error-prop"></a><span class="name">error</span> : <span class="type">Feedback::ErrorType</span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the error status of the <a href="qml-feedbackeffect.html">FeedbackEffect</a>. The error is one of the following values:</p>
<ul>
<li>Feedback.UnknownError - An unknown error occurred</li>
<li>Feedback.DeviceBusy - The device resource is already being used.</li>
</ul>
<p>This property group was introduced in Mobility 1.1.</p>
<p><b>See also </b><a href="feedback.html">Feedback</a> and <a href="qfeedbackeffect.html#ErrorType-enum">QFeedbackEffect::ErrorType</a>.</p>
</div></div><!-- @@@error -->
<br/>
<!-- $$$paused -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="paused-prop"></a><span class="name">paused</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property is true if this feedback effect is paused.</p>
<p>This property group was introduced in Mobility 1.1.</p>
</div></div><!-- @@@paused -->
<br/>
<!-- $$$running -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="running-prop"></a><span class="name">running</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property is true if this feedback effect is running.</p>
<p>This property group was introduced in Mobility 1.1.</p>
</div></div><!-- @@@running -->
<br/>
<!-- $$$state -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="state-prop"></a><span class="name">state</span> : <span class="type">FeedbackEffect::State</span></p></td></tr></table></div><div class="qmldoc"><p>This is the current state of the effect. It is one of:</p>
<ul>
<li>Feedback.Stopped - the effect is not playing</li>
<li>Feedback.Loading - the effect is being loaded</li>
<li>Feedback.Running - the effect is playing</li>
<li>Feedback.Paused - the effect was being played, but is now paused.</li>
</ul>
<p>This property group was introduced in Mobility 1.1.</p>
<p><b>See also </b><a href="feedback.html">Feedback</a>.</p>
</div></div><!-- @@@state -->
<br/>
<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
>
1233
