413 lines
18 KiB
HTML
413 lines
18 KiB
HTML
<?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" />
|
|
<title>Qt 4.8: xqvibra.cpp Example File (widgets/symbianvibration/xqvibra.cpp)</title>
|
|
<link rel="stylesheet" type="text/css" href="style/style.css" />
|
|
<script src="scripts/jquery.js" type="text/javascript"></script>
|
|
<script src="scripts/functions.js" type="text/javascript"></script>
|
|
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
|
|
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
|
|
<!--[if IE]>
|
|
<meta name="MSSmartTagsPreventParsing" content="true">
|
|
<meta http-equiv="imagetoolbar" content="no">
|
|
<![endif]-->
|
|
<!--[if lt IE 7]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
|
|
<![endif]-->
|
|
<!--[if IE 7]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
|
|
<![endif]-->
|
|
<!--[if IE 8]>
|
|
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
|
|
<![endif]-->
|
|
|
|
<script src="scripts/superfish.js" type="text/javascript"></script>
|
|
<script src="scripts/narrow.js" type="text/javascript"></script>
|
|
|
|
</head>
|
|
<body class="" onload="CheckEmptyAndLoadList();">
|
|
<div class="header" id="qtdocheader">
|
|
<div class="content">
|
|
<div id="nav-logo">
|
|
<a href="index.html">Home</a></div>
|
|
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
|
|
<div id="narrowsearch"></div>
|
|
<div id="nav-topright">
|
|
<ul>
|
|
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
|
|
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
|
|
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
|
|
DOC</a></li>
|
|
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="shortCut">
|
|
<ul>
|
|
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
|
|
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
|
|
</ul>
|
|
</div>
|
|
<ul class="sf-menu" id="narrowmenu">
|
|
<li><a href="#">API Lookup</a>
|
|
<ul>
|
|
<li><a href="classes.html">Class index</a></li>
|
|
<li><a href="functions.html">Function index</a></li>
|
|
<li><a href="modules.html">Modules</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="qtglobal.html">Global Declarations</a></li>
|
|
<li><a href="qdeclarativeelements.html">QML elements</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Qt Topics</a>
|
|
<ul>
|
|
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
|
|
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
|
|
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
|
|
<li><a href="supported-platforms.html">Supported Platforms</a></li>
|
|
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
|
|
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#">Examples</a>
|
|
<ul>
|
|
<li><a href="all-examples.html">Examples</a></li>
|
|
<li><a href="tutorials.html">Tutorials</a></li>
|
|
<li><a href="demos.html">Demos</a></li>
|
|
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="wrapper">
|
|
<div class="hd">
|
|
<span></span>
|
|
</div>
|
|
<div class="bd group">
|
|
<div class="sidebar">
|
|
<div class="searchlabel">
|
|
Search index:</div>
|
|
<div class="search" id="sidebarsearch">
|
|
<form id="qtdocsearch" action="" onsubmit="return false;">
|
|
<fieldset>
|
|
<input type="text" name="searchstring" id="pageType" value="" />
|
|
<div id="resultdialog">
|
|
<a href="#" id="resultclose">Close</a>
|
|
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
|
|
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
|
|
<ul id="resultlist" class="all">
|
|
</ul>
|
|
</div>
|
|
</fieldset>
|
|
</form>
|
|
</div>
|
|
<div class="box first bottombar" id="lookup">
|
|
<h2 title="API Lookup"><span></span>
|
|
API Lookup</h2>
|
|
<div id="list001" class="list">
|
|
<ul id="ul001" >
|
|
<li class="defaultLink"><a href="classes.html">Class index</a></li>
|
|
<li class="defaultLink"><a href="functions.html">Function index</a></li>
|
|
<li class="defaultLink"><a href="modules.html">Modules</a></li>
|
|
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
|
|
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
|
|
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="box bottombar" id="topics">
|
|
<h2 title="Qt Topics"><span></span>
|
|
Qt Topics</h2>
|
|
<div id="list002" class="list">
|
|
<ul id="ul002" >
|
|
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
|
|
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
|
|
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
|
|
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
|
|
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
|
|
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="box" id="examples">
|
|
<h2 title="Examples"><span></span>
|
|
Examples</h2>
|
|
<div id="list003" class="list">
|
|
<ul id="ul003">
|
|
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
|
|
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
|
|
<li class="defaultLink"><a href="demos.html">Demos</a></li>
|
|
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="wrap">
|
|
<div class="toolbar">
|
|
<div class="breadcrumb toolblock">
|
|
<ul>
|
|
<li class="first"><a href="index.html">Home</a></li>
|
|
<!-- Breadcrumbs go here -->
|
|
</ul>
|
|
</div>
|
|
<div class="toolbuttons toolblock">
|
|
<ul>
|
|
<li id="smallA" class="t_button">A</li>
|
|
<li id="medA" class="t_button active">A</li>
|
|
<li id="bigA" class="t_button">A</li>
|
|
<li id="print" class="t_button"><a href="javascript:this.print();">
|
|
<span>Print</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="content mainContent">
|
|
<h1 class="title">xqvibra.cpp Example File</h1>
|
|
<span class="small-subtitle">widgets/symbianvibration/xqvibra.cpp</span>
|
|
<!-- $$$widgets/symbianvibration/xqvibra.cpp-description -->
|
|
<div class="descr"> <a name="details"></a>
|
|
<pre class="cpp"> <span class="comment">/****************************************************************************
|
|
**
|
|
** Copyright (C) 2015 The Qt Company Ltd.
|
|
** Contact: http://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtCore module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:BSD$
|
|
** You may use this file under the terms of the BSD license as follows:
|
|
**
|
|
** "Redistribution and use in source and binary forms, with or without
|
|
** modification, are permitted provided that the following conditions are
|
|
** met:
|
|
** * Redistributions of source code must retain the above copyright
|
|
** notice, this list of conditions and the following disclaimer.
|
|
** * Redistributions in binary form must reproduce the above copyright
|
|
** notice, this list of conditions and the following disclaimer in
|
|
** the documentation and/or other materials provided with the
|
|
** distribution.
|
|
** * Neither the name of The Qt Company Ltd nor the names of its
|
|
** contributors may be used to endorse or promote products derived
|
|
** from this software without specific prior written permission.
|
|
**
|
|
**
|
|
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/</span>
|
|
|
|
<span class="preprocessor">#include "xqvibra.h"</span>
|
|
<span class="preprocessor">#include "xqvibra_p.h"</span>
|
|
|
|
<span class="comment">/*!
|
|
\class XQVibra
|
|
|
|
\brief The XQVibra class is used to control the device's vibra. The XQVibra
|
|
class provides also information of vibration setting in the user profile.
|
|
|
|
Example:
|
|
\code
|
|
XQVibra *vibra = new XQVibra(this);
|
|
QPushButton *startButton = new QPushButton(this);
|
|
QPushButton *stopButton = new QPushButton(this);
|
|
connect(startButton, SIGNAL(clicked()), vibra, SLOT(start()));
|
|
connect(stopButton, SIGNAL(clicked()), vibra, SLOT(stop()));
|
|
\endcode
|
|
*/</span>
|
|
|
|
<span class="comment">/*! \var XQVibra::InfiniteDuration
|
|
With this constant vibration can be set to work indefinitely (Note! Depends on the HW)
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::MaxIntensity
|
|
Maximum intensity as percentages
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::MinIntensity
|
|
Minimum intensity as percentages
|
|
*/</span>
|
|
|
|
<span class="comment">/*!
|
|
Constructs a XQVibra object with the given parent.
|
|
Call error() to get a value of XQVibra::Error that indicates which error occurred during initialisation if any.
|
|
\sa start(), setIntensity(), error()
|
|
*/</span>
|
|
XQVibra<span class="operator">::</span>XQVibra(<span class="type"><a href="qobject.html">QObject</a></span> <span class="operator">*</span>parent)
|
|
: <span class="type"><a href="qobject.html">QObject</a></span>(parent)<span class="operator">,</span> d(<span class="keyword">new</span> XQVibraPrivate(<span class="keyword">this</span>))
|
|
{
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
Destroys the XQVibra object.
|
|
*/</span>
|
|
XQVibra<span class="operator">::</span><span class="operator">~</span>XQVibra()
|
|
{
|
|
<span class="keyword">delete</span> d;
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
\enum XQVibra::Error
|
|
|
|
This enum defines the possible errors for a XQVibra object.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::NoError
|
|
No error occurred.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::OutOfMemoryError
|
|
Not enough memory.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::ArgumentError
|
|
Duration is invalid.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::VibraInUseError
|
|
Vibra is already in used by other client.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::HardwareError
|
|
There is a hardware error.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::TimeOutError
|
|
Timeout occurred in controlling vibra.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::VibraLockedError
|
|
Vibra is locked down because too much continuous use or explicitly blocked by
|
|
for example some vibration sensitive accessory.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::AccessDeniedError
|
|
Vibration setting in the user profile is not set.
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Error XQVibra::UnknownError
|
|
Unknown error.
|
|
*/</span>
|
|
|
|
<span class="comment">/*!
|
|
\enum XQVibra::Status
|
|
|
|
This enum defines the possible statuses of the vibration
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Status XQVibra::StatusNotAllowed
|
|
Vibra is set off in the user profile or status is unknow
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Status XQVibra::StatusOff
|
|
Vibration is non-active
|
|
*/</span>
|
|
<span class="comment">/*! \var XQVibra::Status XQVibra::StatusOn
|
|
Vibration is active
|
|
*/</span>
|
|
|
|
<span class="comment">/*!
|
|
Starts vibrating. If duration hasn't been set the vibration continues
|
|
indefinitely unless stopped with stop() function. Calling the start while vibration
|
|
is active the active vibration is interrupted and the new vibration starts immediately.
|
|
|
|
\param duration Specifies duration how long vibration should last
|
|
\return If false is returned, an error has occurred. Call error() to get a value of
|
|
XQVibra::Error that indicates which error occurred
|
|
\sa stop(), setIntensity(), error()
|
|
*/</span>
|
|
<span class="type">bool</span> XQVibra<span class="operator">::</span>start(<span class="type">int</span> duration)
|
|
{
|
|
<span class="keyword">return</span> d<span class="operator">-</span><span class="operator">></span>start(duration);
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
Interrupts the device vibration immediately.
|
|
|
|
\return If false is returned, an error has occurred. Call error() to get a value of
|
|
XQVibra::Error that indicates which error occurred
|
|
\sa start(), setIntensity(), error()
|
|
*/</span>
|
|
<span class="type">bool</span> XQVibra<span class="operator">::</span>stop()
|
|
{
|
|
<span class="keyword">return</span> d<span class="operator">-</span><span class="operator">></span>stop();
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
Sets the intensity of the vibration. Allowed values for the intensity are
|
|
between -100 and 100. 0 means no vibrating. NOTE: The device might have
|
|
hardware-imposed limits on supported vibra intensity values, so actual
|
|
effect might vary between different hardware.
|
|
|
|
\param intensity Intensity of the vibra in decimals
|
|
\return If false is returned, an error has occurred. Call error() to get a value of
|
|
XQVibra::Error that indicates which error occurred
|
|
\sa error()
|
|
*/</span>
|
|
<span class="type">bool</span> XQVibra<span class="operator">::</span>setIntensity(<span class="type">int</span> intensity)
|
|
{
|
|
<span class="keyword">return</span> d<span class="operator">-</span><span class="operator">></span>setIntensity(intensity);
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
Returns the current status of the vibration. This function can be used to check has vibration
|
|
allowed in the user profile.
|
|
|
|
\return current status
|
|
\sa statusChanged()
|
|
*/</span>
|
|
XQVibra<span class="operator">::</span>Status XQVibra<span class="operator">::</span>currentStatus() <span class="keyword">const</span>
|
|
{
|
|
<span class="keyword">return</span> d<span class="operator">-</span><span class="operator">></span>currentStatus();
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
Returns the type of error that occurred if the latest function call failed; otherwise returns NoError
|
|
\return Error code
|
|
*/</span>
|
|
XQVibra<span class="operator">::</span>Error XQVibra<span class="operator">::</span>error() <span class="keyword">const</span>
|
|
{
|
|
<span class="keyword">return</span> d<span class="operator">-</span><span class="operator">></span>error();
|
|
}
|
|
|
|
<span class="comment">/*!
|
|
\fn void XQVibra::statusChanged(Status status)
|
|
|
|
This signal is emitted when the there is a change of the vibration status.
|
|
|
|
\param status a vibration status
|
|
\sa currentStatus()
|
|
*/</span>
|
|
|
|
<span class="comment">// End of file</span></pre>
|
|
</div>
|
|
<!-- @@@widgets/symbianvibration/xqvibra.cpp -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="ft">
|
|
<span></span>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<p>
|
|
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
|
|
Documentation contributions included herein are the copyrights of
|
|
their respective owners.</p>
|
|
<br />
|
|
<p>
|
|
The documentation provided herein is licensed 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>
|
|
<p>
|
|
Documentation sources may be obtained from <a href="http://www.qt-project.org">
|
|
www.qt-project.org</a>.</p>
|
|
<br />
|
|
<p>
|
|
Qt and respective logos are trademarks of The Qt Company Ltd
|
|
in Finland and/or other countries worldwide. All other trademarks are property
|
|
of their respective owners. <a title="Privacy Policy"
|
|
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
|
|
</div>
|
|
|
|
<script src="scripts/functions.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|