/usr/share/qt5/doc/qtfeedback/qfeedbackhapticsinterface.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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qfeedbackplugin.cpp -->
<title>QFeedbackHapticsInterface Class | 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>QFeedbackHapticsInterface</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="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</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>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QFeedbackHapticsInterface Class</h1>
<!-- $$$QFeedbackHapticsInterface-brief -->
<p>The <a href="qfeedbackhapticsinterface.html">QFeedbackHapticsInterface</a> class is the base class for plugins providing custom haptics effects. <a href="#details">More...</a></p>
<!-- @@@QFeedbackHapticsInterface -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QFeedbackHapticsInterface></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qfeedbackinterface.html">QFeedbackInterface</a></td></tr></table></div><ul>
<li><a href="qfeedbackhapticsinterface-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a></b> { Name, State, Enabled }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#EffectProperty-enum">EffectProperty</a></b> { Duration, Intensity, AttackTime, AttackIntensity, ..., Period }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#actuatorProperty">actuatorProperty</a></b>(const QFeedbackActuator &<i> actuator</i>, ActuatorProperty<i> property</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QFeedbackActuator *> </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#actuators">actuators</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QFeedbackEffect::State </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#effectState">effectState</a></b>(const QFeedbackHapticsEffect *<i> effect</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#isActuatorCapabilitySupported">isActuatorCapabilitySupported</a></b>(const QFeedbackActuator &<i> actuator</i>, QFeedbackActuator::Capability<i> capability</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual PluginPriority </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#pluginPriority">pluginPriority</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#setActuatorProperty">setActuatorProperty</a></b>(const QFeedbackActuator &<i> actuator</i>, ActuatorProperty<i> property</i>, const QVariant &<i> value</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#setEffectState">setEffectState</a></b>(const QFeedbackHapticsEffect *<i> effect</i>, QFeedbackEffect::State<i> state</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#updateEffectProperty">updateEffectProperty</a></b>(const QFeedbackHapticsEffect *<i> effect</i>, EffectProperty<i> property</i>) = 0</td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QFeedbackActuator * </td><td class="memItemRight bottomAlign"><b><a href="qfeedbackhapticsinterface.html#createFeedbackActuator">createFeedbackActuator</a></b>(QObject *<i> parent</i>, int<i> id</i>)</td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 static protected member inherited from <a href="qfeedbackinterface.html#static-protected-members">QFeedbackInterface</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFeedbackHapticsInterface-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qfeedbackhapticsinterface.html">QFeedbackHapticsInterface</a> class is the base class for plugins providing custom haptics effects.</p>
<p>This interface will be used to try to play custom effects with specific duration, intensity, envelope and period. An effect is always played on a specified actuator.</p>
</div>
<!-- @@@QFeedbackHapticsInterface -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ActuatorProperty$$$Name$$$State$$$Enabled -->
<h3 class="fn" id="ActuatorProperty-enum"><a name="ActuatorProperty-enum"></a>enum QFeedbackHapticsInterface::<span class="name">ActuatorProperty</span></h3>
<p>This enum describes all actuator properties.</p>
<div class="table"><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"><code>QFeedbackHapticsInterface::Name</code></td><td class="topAlign"><code>0</code></td><td class="topAlign">The actuator name.</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::State</code></td><td class="topAlign"><code>1</code></td><td class="topAlign">The actuator state.</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::Enabled</code></td><td class="topAlign"><code>2</code></td><td class="topAlign">The actuator enabled state.</td></tr>
</table></div>
<!-- @@@ActuatorProperty -->
<!-- $$$EffectProperty$$$Duration$$$Intensity$$$AttackTime$$$AttackIntensity$$$FadeTime$$$FadeIntensity$$$Period -->
<h3 class="fn" id="EffectProperty-enum"><a name="EffectProperty-enum"></a>enum QFeedbackHapticsInterface::<span class="name">EffectProperty</span></h3>
<p>This enum describes all effect properties for haptics effects.</p>
<div class="table"><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"><code>QFeedbackHapticsInterface::Duration</code></td><td class="topAlign"><code>0</code></td><td class="topAlign">The effect duration (in milliseconds)</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::Intensity</code></td><td class="topAlign"><code>1</code></td><td class="topAlign">The effect intensity</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::AttackTime</code></td><td class="topAlign"><code>2</code></td><td class="topAlign">The effect attack time (in milliseconds)</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::AttackIntensity</code></td><td class="topAlign"><code>3</code></td><td class="topAlign">The effect attack intensity</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::FadeTime</code></td><td class="topAlign"><code>4</code></td><td class="topAlign">The effect fade time (in milliseconds)</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::FadeIntensity</code></td><td class="topAlign"><code>5</code></td><td class="topAlign">The effect fade intensity</td></tr>
<tr><td class="topAlign"><code>QFeedbackHapticsInterface::Period</code></td><td class="topAlign"><code>6</code></td><td class="topAlign">The effect period, this is an optional effect property.</td></tr>
</table></div>
<!-- @@@EffectProperty -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$actuatorProperty[overload1]$$$actuatorPropertyconstQFeedbackActuator&ActuatorProperty -->
<h3 class="fn" id="actuatorProperty"><a name="actuatorProperty"></a><code>[pure virtual] </code><span class="type">QVariant</span> QFeedbackHapticsInterface::<span class="name">actuatorProperty</span>(const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &<i> actuator</i>, <span class="type"><a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a></span><i> property</i>)</h3>
<p>Returns the value for the <i>property</i> for an <i>actuator</i>.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#setActuatorProperty">setActuatorProperty</a>() and <a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a>.</p>
<!-- @@@actuatorProperty -->
<!-- $$$actuators[overload1]$$$actuators -->
<h3 class="fn" id="actuators"><a name="actuators"></a><code>[pure virtual] </code><span class="type">QList</span><<span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> *> QFeedbackHapticsInterface::<span class="name">actuators</span>()</h3>
<p>Return the available actuators provided by this plugin. The ownership of the actuator objects stays with the plugin.</p>
<!-- @@@actuators -->
<!-- $$$createFeedbackActuator[overload1]$$$createFeedbackActuatorQObject*int -->
<h3 class="fn" id="createFeedbackActuator"><a name="createFeedbackActuator"></a><code>[protected] </code><span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> * QFeedbackHapticsInterface::<span class="name">createFeedbackActuator</span>(<span class="type">QObject</span> *<i> parent</i>, <span class="type">int</span><i> id</i>)</h3>
<p>Creates an instance of <a href="qfeedbackactuator.html">QFeedbackActuator</a> with the identifier <i>id</i> and parent <i>parent</i>. This allows backends to create instances of actuators. It is then up to the each backend to manage the identifiers according to its needs.</p>
<!-- @@@createFeedbackActuator -->
<!-- $$$effectState[overload1]$$$effectStateconstQFeedbackHapticsEffect* -->
<h3 class="fn" id="effectState"><a name="effectState"></a><code>[pure virtual] </code><span class="type"><a href="qfeedbackeffect.html#State-enum">QFeedbackEffect::State</a></span> QFeedbackHapticsInterface::<span class="name">effectState</span>(const <span class="type"><a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a></span> *<i> effect</i>)</h3>
<p>Get the current state for the effect <i>effect</i>.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#setEffectState">setEffectState</a>().</p>
<!-- @@@effectState -->
<!-- $$$isActuatorCapabilitySupported[overload1]$$$isActuatorCapabilitySupportedconstQFeedbackActuator&QFeedbackActuator::Capability -->
<h3 class="fn" id="isActuatorCapabilitySupported"><a name="isActuatorCapabilitySupported"></a><code>[pure virtual] </code><span class="type">bool</span> QFeedbackHapticsInterface::<span class="name">isActuatorCapabilitySupported</span>(const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &<i> actuator</i>, <span class="type"><a href="qfeedbackactuator.html#Capability-enum">QFeedbackActuator::Capability</a></span><i> capability</i>)</h3>
<p>Returns true if the <i>actuator</i> supports the <i>capability</i>.</p>
<!-- @@@isActuatorCapabilitySupported -->
<!-- $$$pluginPriority[overload1]$$$pluginPriority -->
<h3 class="fn" id="pluginPriority"><a name="pluginPriority"></a><code>[pure virtual] </code><span class="type"><a href="qfeedbackinterface.html#PluginPriority-enum">PluginPriority</a></span> QFeedbackHapticsInterface::<span class="name">pluginPriority</span>()</h3>
<p>Returns the priority for the plugin.</p>
<p><b>See also </b><a href="qfeedbackinterface.html#PluginPriority-enum">QFeedbackInterface::PluginPriority</a>.</p>
<!-- @@@pluginPriority -->
<!-- $$$setActuatorProperty[overload1]$$$setActuatorPropertyconstQFeedbackActuator&ActuatorPropertyconstQVariant& -->
<h3 class="fn" id="setActuatorProperty"><a name="setActuatorProperty"></a><code>[pure virtual] </code><span class="type">void</span> QFeedbackHapticsInterface::<span class="name">setActuatorProperty</span>(const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &<i> actuator</i>, <span class="type"><a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a></span><i> property</i>, const <span class="type">QVariant</span> &<i> value</i>)</h3>
<p>Sets a <i>value</i> for <i>property</i> on the <i>actuator</i>.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#actuatorProperty">actuatorProperty</a>() and <a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a>.</p>
<!-- @@@setActuatorProperty -->
<!-- $$$setEffectState[overload1]$$$setEffectStateconstQFeedbackHapticsEffect*QFeedbackEffect::State -->
<h3 class="fn" id="setEffectState"><a name="setEffectState"></a><code>[pure virtual] </code><span class="type">void</span> QFeedbackHapticsInterface::<span class="name">setEffectState</span>(const <span class="type"><a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a></span> *<i> effect</i>, <span class="type"><a href="qfeedbackeffect.html#State-enum">QFeedbackEffect::State</a></span><i> state</i>)</h3>
<p>Sets the state to <i>state</i> for the effect <i>effect</i>. If that fails the backend should report an error by calling <a href="qfeedbackinterface.html#reportError">reportError</a> and <i>effect</i> will in turn emit an error signal.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#effectState">effectState</a>().</p>
<!-- @@@setEffectState -->
<!-- $$$updateEffectProperty[overload1]$$$updateEffectPropertyconstQFeedbackHapticsEffect*EffectProperty -->
<h3 class="fn" id="updateEffectProperty"><a name="updateEffectProperty"></a><code>[pure virtual] </code><span class="type">void</span> QFeedbackHapticsInterface::<span class="name">updateEffectProperty</span>(const <span class="type"><a href="qfeedbackhapticseffect.html">QFeedbackHapticsEffect</a></span> *<i> effect</i>, <span class="type"><a href="qfeedbackhapticsinterface.html#EffectProperty-enum">EffectProperty</a></span><i> property</i>)</h3>
<p>Tells the backend that the <i>property</i> has been updated for the supplied <i>effect</i>.</p>
<!-- @@@updateEffectProperty -->
</div>
<div class="footer">Copyright (c) 2011 Nokia Corporation and/or its subsidiaries. All rights reserved.</div>
</body>
</html>
|