Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 822

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?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" />
<!-- qfeedbackplugin.cpp -->
  <title>Qt Mobility 1.2: QFeedbackHapticsInterface 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>QFeedbackHapticsInterface</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="#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>
<h1 class="title">QFeedbackHapticsInterface Class Reference</h1>
<!-- $$$QFeedbackHapticsInterface-brief -->
<p>The QFeedbackHapticsInterface class is the base class for plugins providing custom haptics effects. <a href="#details">More...</a></p>
<!-- @@@QFeedbackHapticsInterface -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QFeedbackHapticsInterface&gt;</span></pre><p><b>Inherits: </b><a href="qfeedbackinterface.html">QFeedbackInterface</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qfeedbackhapticsinterface-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="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>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<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 &amp; <i>actuator</i>, ActuatorProperty <i>property</i> ) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList&lt;QFeedbackActuator *&gt; </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 &amp; <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 &amp; <i>actuator</i>, ActuatorProperty <i>property</i>, const QVariant &amp; <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>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<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>
<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>Detailed Description</h2>
<p>The QFeedbackHapticsInterface 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"><a name="ActuatorProperty-enum"></a>enum QFeedbackHapticsInterface::<span class="name">ActuatorProperty</span></h3>
<p>This enum describes all actuator properties.</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>QFeedbackHapticsInterface::Name</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The actuator name.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::State</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The actuator state.</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::Enabled</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The actuator enabled state.</td></tr>
</table>
<!-- @@@ActuatorProperty -->
<!-- $$$EffectProperty$$$Duration$$$Intensity$$$AttackTime$$$AttackIntensity$$$FadeTime$$$FadeIntensity$$$Period -->
<h3 class="fn"><a name="EffectProperty-enum"></a>enum QFeedbackHapticsInterface::<span class="name">EffectProperty</span></h3>
<p>This enum describes all effect properties for haptics effects.</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>QFeedbackHapticsInterface::Duration</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The effect duration (in milliseconds)</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::Intensity</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The effect intensity</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::AttackTime</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The effect attack time (in milliseconds)</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::AttackIntensity</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The effect attack intensity</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::FadeTime</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">The effect fade time (in milliseconds)</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::FadeIntensity</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">The effect fade intensity</td></tr>
<tr><td class="topAlign"><tt>QFeedbackHapticsInterface::Period</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">The effect period, this is an optional effect property.</td></tr>
</table>
<!-- @@@EffectProperty -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$actuatorProperty[overload1]$$$actuatorPropertyconstQFeedbackActuator&ActuatorProperty -->
<h3 class="fn"><a name="actuatorProperty"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QFeedbackHapticsInterface::<span class="name">actuatorProperty</span> ( const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &amp; <i>actuator</i>, <span class="type"><a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a></span> <i>property</i> )<tt> [pure virtual]</tt></h3>
<p>Returns the value for the <i>property</i> for an <i>actuator</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</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"><a name="actuators"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> *&gt; QFeedbackHapticsInterface::<span class="name">actuators</span> ()<tt> [pure virtual]</tt></h3>
<p>Return the available actuators provided by this plugin. The ownership of the actuator objects stays with the plugin.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@actuators -->
<!-- $$$createFeedbackActuator[overload1]$$$createFeedbackActuatorQObject*int -->
<h3 class="fn"><a name="createFeedbackActuator"></a><span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> * QFeedbackHapticsInterface::<span class="name">createFeedbackActuator</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i>, <span class="type">int</span> <i>id</i> )<tt> [protected]</tt></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>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@createFeedbackActuator -->
<!-- $$$effectState[overload1]$$$effectStateconstQFeedbackHapticsEffect* -->
<h3 class="fn"><a name="effectState"></a><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> )<tt> [pure virtual]</tt></h3>
<p>Get the current state for the effect <i>effect</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#setEffectState">setEffectState</a>().</p>
<!-- @@@effectState -->
<!-- $$$isActuatorCapabilitySupported[overload1]$$$isActuatorCapabilitySupportedconstQFeedbackActuator&QFeedbackActuator::Capability -->
<h3 class="fn"><a name="isActuatorCapabilitySupported"></a><span class="type">bool</span> QFeedbackHapticsInterface::<span class="name">isActuatorCapabilitySupported</span> ( const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &amp; <i>actuator</i>, <span class="type"><a href="qfeedbackactuator.html#Capability-enum">QFeedbackActuator::Capability</a></span> <i>capability</i> )<tt> [pure virtual]</tt></h3>
<p>Returns true if the <i>actuator</i> supports the <i>capability</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isActuatorCapabilitySupported -->
<!-- $$$pluginPriority[overload1]$$$pluginPriority -->
<h3 class="fn"><a name="pluginPriority"></a><span class="type"><a href="qfeedbackinterface.html#PluginPriority-enum">PluginPriority</a></span> QFeedbackHapticsInterface::<span class="name">pluginPriority</span> ()<tt> [pure virtual]</tt></h3>
<p>Returns the priority for the plugin.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackinterface.html#PluginPriority-enum">QFeedbackInterface::PluginPriority</a>.</p>
<!-- @@@pluginPriority -->
<!-- $$$setActuatorProperty[overload1]$$$setActuatorPropertyconstQFeedbackActuator&ActuatorPropertyconstQVariant& -->
<h3 class="fn"><a name="setActuatorProperty"></a><span class="type">void</span> QFeedbackHapticsInterface::<span class="name">setActuatorProperty</span> ( const <span class="type"><a href="qfeedbackactuator.html">QFeedbackActuator</a></span> &amp; <i>actuator</i>, <span class="type"><a href="qfeedbackhapticsinterface.html#ActuatorProperty-enum">ActuatorProperty</a></span> <i>property</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )<tt> [pure virtual]</tt></h3>
<p>Sets a <i>value</i> for <i>property</i> on the <i>actuator</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</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"><a name="setEffectState"></a><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> )<tt> [pure virtual]</tt></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 reportError and <i>effect</i> will in turn emit an error signal.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qfeedbackhapticsinterface.html#effectState">effectState</a>().</p>
<!-- @@@setEffectState -->
<!-- $$$updateEffectProperty[overload1]$$$updateEffectPropertyconstQFeedbackHapticsEffect*EffectProperty -->
<h3 class="fn"><a name="updateEffectProperty"></a><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> )<tt> [pure virtual]</tt></h3>
<p>Tells the backend that the <i>property</i> has been updated for the supplied <i>effect</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@updateEffectProperty -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional