/usr/share/qt5/doc/qtfeedback/qml-feedbackeffect.html is in qtfeedback5-doc-html 5.0~git20130529-0ubuntu13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativefeedbackeffect.cpp -->
<title>FeedbackEffect QML Type | Qt 5.0 </title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
</head>
<body>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.0</li>
<li id="buildversion">Qt 5.0.0 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">FeedbackEffect QML Type</h1>
<span class="subtitle"></span>
<!-- $$$FeedbackEffect-brief -->
<p>The <a href="qml-feedbackeffect.html">FeedbackEffect</a> element is the base class for all feedback effects. <a href="#details">More...</a></p>
<!-- @@@FeedbackEffect -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import .</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-hapticseffect.html">HapticsEffect</a></p>
</td></tr></table></div><ul>
<li><a href="qml-feedbackeffect-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">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 id="details">Detailed Description</h2>
</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>FileEffect, <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"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="duration-prop"><td class="tblQmlPropNode"><p><a name="duration-prop"></a><span class="name">duration</span> : <span class="type">int</span></p></td></tr></table></div></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><b>See also </b>Feedback.</p>
</div></div><!-- @@@duration -->
<br/>
<!-- $$$error -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="error-prop"><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><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><b>See also </b>Feedback and <a href="qfeedbackeffect.html#ErrorType-enum">QFeedbackEffect::ErrorType</a>.</p>
</div></div><!-- @@@error -->
<br/>
<!-- $$$paused -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="paused-prop"><td class="tblQmlPropNode"><p><a name="paused-prop"></a><span class="name">paused</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property is true if this feedback effect is paused.</p>
</div></div><!-- @@@paused -->
<br/>
<!-- $$$running -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="running-prop"><td class="tblQmlPropNode"><p><a name="running-prop"></a><span class="name">running</span> : <span class="type">bool</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property is true if this feedback effect is running.</p>
</div></div><!-- @@@running -->
<br/>
<!-- $$$state -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="state-prop"><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><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><b>See also </b>Feedback.</p>
</div></div><!-- @@@state -->
<br/>
<div class="footer">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>
</body>
</html>
|