Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-updates > by-pkgid > c04d50e59eacd9c02ba2ba4314d42c39 > files > 34

qtserialport5-doc-5.9.4-1.mga6.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qserialport.cpp -->
  <title>Obsolete Members for QSerialPort | Qt Serial Port 5.9</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.9</td><td ><a href="qtserialport-index.html">Qt Serial Port</a></td><td ><a href="qtserialport-module.html">C++ Classes</a></td><td >QSerialPort</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Obsolete Members for QSerialPort</h1>
<p><b>The following members of class <a href="qserialport.html">QSerialPort</a> are obsolete.</b> They are provided to keep old source code working. We strongly advise against using them in new code.</p>
<h2>Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>enum </td><td class="memItemRight bottomAlign"><b><a href="qserialport-obsolete.html#DataErrorPolicy-enum">DataErrorPolicy</a></b> { SkipPolicy, PassZeroPolicy, IgnorePolicy, StopReceivingPolicy, UnknownPolicy }</td></tr>
</table></div>
<h2>Properties</h2>
<ul>
<li class="fn"><code>(obsolete) </code><b><a href="qserialport-obsolete.html#dataErrorPolicy-prop">dataErrorPolicy</a></b> : DataErrorPolicy</li>
<li class="fn"><code>(obsolete) </code><b><a href="qserialport-obsolete.html#settingsRestoredOnClose-prop">settingsRestoredOnClose</a></b> : bool</li>
</ul>
<h2>Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> <code>(obsolete) </code>void </td><td class="memItemRight bottomAlign"><b><a href="qserialport-obsolete.html#error-1">error</a></b>(QSerialPort::SerialPortError <i>error</i>)</td></tr>
</table></div>
<h2>Member Type Documentation</h2>
<!-- $$$DataErrorPolicy$$$SkipPolicy$$$PassZeroPolicy$$$IgnorePolicy$$$StopReceivingPolicy$$$UnknownPolicy -->
<h3 class="fn" id="DataErrorPolicy-enum"><a name="DataErrorPolicy-enum"></a>enum QSerialPort::<span class="name">DataErrorPolicy</span></h3>
<p>This enum describes the policies for the received symbols while parity errors were detected.</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>QSerialPort::SkipPolicy</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Skips the bad character.</td></tr>
<tr><td class="topAlign"><code>QSerialPort::PassZeroPolicy</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Replaces bad character with zero.</td></tr>
<tr><td class="topAlign"><code>QSerialPort::IgnorePolicy</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Ignores the error for a bad character.</td></tr>
<tr><td class="topAlign"><code>QSerialPort::StopReceivingPolicy</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Stops data reception on error.</td></tr>
<tr><td class="topAlign"><code>QSerialPort::UnknownPolicy</code></td><td class="topAlign tblval"><code>-1</code></td><td class="topAlign">Unknown policy.</td></tr>
</table></div>
<p><b>See also </b><a href="qserialport-obsolete.html#dataErrorPolicy-prop">QSerialPort::dataErrorPolicy</a>.</p>
<!-- @@@DataErrorPolicy -->
<h2>Property Documentation</h2>
<!-- $$$dataErrorPolicy-prop$$$dataErrorPolicy$$$setDataErrorPolicyDataErrorPolicy$$$dataErrorPolicyChangedQSerialPort::DataErrorPolicy -->
<h3 class="fn" id="dataErrorPolicy-prop"><a name="dataErrorPolicy-prop"></a><span class="name">dataErrorPolicy</span> : <span class="type"><a href="qserialport-obsolete.html#DataErrorPolicy-enum">DataErrorPolicy</a></span></h3>
<p>This property holds the error policy for how the process receives characters in the case where a parity error is detected.</p>
<p>If the setting is successful, returns <code>true</code>; otherwise returns <code>false</code>. The default policy set is <a href="qserialport-obsolete.html#DataErrorPolicy-enum">IgnorePolicy</a>.</p>
<p><b>Note: </b>The serial port has to be open before trying to set this property; otherwise returns <code>false</code> and sets the <a href="qserialport.html#SerialPortError-enum">NotOpenError</a> error code. This is a bit unusual as opposed to the regular Qt property settings of a class. However, this is a special use case since the property is set through the interaction with the kernel and hardware. Hence, the two scenarios cannot be completely compared to each other.</p><p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> DataErrorPolicy </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport.html#dataErrorPolicy-prop">dataErrorPolicy</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport.html#dataErrorPolicy-prop">setDataErrorPolicy</a></b></span>(DataErrorPolicy <i>policy</i> = IgnorePolicy)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport-obsolete.html#dataErrorPolicyChanged">dataErrorPolicyChanged</a></b></span>(QSerialPort::DataErrorPolicy <i>policy</i>)</td></tr>
</table></div>
<!-- @@@dataErrorPolicy -->
<!-- $$$settingsRestoredOnClose-prop$$$settingsRestoredOnClose$$$setSettingsRestoredOnClosebool$$$settingsRestoredOnCloseChangedbool -->
<h3 class="fn" id="settingsRestoredOnClose-prop"><a name="settingsRestoredOnClose-prop"></a><span class="name">settingsRestoredOnClose</span> : <span class="type">bool</span></h3>
<p>This property holds the flag which specifies to restore the previous settings when closing the serial port.</p>
<p>If this flag is <code>true</code>, the settings will be restored; otherwise not. The default state of the <a href="qserialport.html">QSerialPort</a> class is to restore the settings.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport.html#settingsRestoredOnClose-prop">settingsRestoredOnClose</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport.html#settingsRestoredOnClose-prop">setSettingsRestoredOnClose</a></b></span>(bool <i>restore</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qserialport-obsolete.html#settingsRestoredOnCloseChanged">settingsRestoredOnCloseChanged</a></b></span>(bool <i>restore</i>)</td></tr>
</table></div>
<!-- @@@settingsRestoredOnClose -->
<h2>Member Function Documentation</h2>
<!-- $$$dataErrorPolicyChanged -->
<h3 class="fn" id="dataErrorPolicyChanged"><a name="dataErrorPolicyChanged"></a><code>[signal] </code><span class="type">void</span> QSerialPort::<span class="name">dataErrorPolicyChanged</span>(<span class="type"><a href="qserialport-obsolete.html#DataErrorPolicy-enum">QSerialPort::DataErrorPolicy</a></span> <i>policy</i>)</h3>
<p>This signal is emitted after the error policy for how the process receives characters in case of parity error detection has been changed. The new error policy for how the process receives the character in case of parity error detection is passed as <i>policy</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qserialport-obsolete.html#dataErrorPolicy-prop">dataErrorPolicy</a>. </p><p><b>See also </b><a href="qserialport-obsolete.html#dataErrorPolicy-prop">QSerialPort::dataErrorPolicy</a>.</p>
<!-- @@@dataErrorPolicyChanged -->
<!-- $$$error$$$errorQSerialPort::SerialPortError -->
<h3 class="fn" id="error-1"><a name="error-1"></a><code>[signal] </code><span class="type">void</span> QSerialPort::<span class="name">error</span>(<span class="type"><a href="qserialport.html#SerialPortError-enum">QSerialPort::SerialPortError</a></span> <i>error</i>)</h3>
<p>Use <a href="qserialport.html#errorOccurred">errorOccurred</a>() instead.</p>
<p><b>Note:</b> Signal <i>error</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">

  connect(serialPort<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator">&lt;</span><span class="type">void</span>(<span class="type"><a href="qserialport.html#QSerialPort">QSerialPort</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qserialport.html#QSerialPort">QSerialPort</a></span><span class="operator">::</span>SerialPortError)<span class="operator">&gt;</span>(<span class="operator">&amp;</span><span class="type"><a href="qserialport.html#QSerialPort">QSerialPort</a></span><span class="operator">::</span>error)<span class="operator">,</span>
      <span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qserialport.html#QSerialPort">QSerialPort</a></span><span class="operator">::</span>SerialPortError error){ <span class="comment">/* ... */</span> });

</pre>
<!-- @@@error -->
<!-- $$$settingsRestoredOnCloseChanged -->
<h3 class="fn" id="settingsRestoredOnCloseChanged"><a name="settingsRestoredOnCloseChanged"></a><code>[signal] </code><span class="type">void</span> QSerialPort::<span class="name">settingsRestoredOnCloseChanged</span>(<span class="type">bool</span> <i>restore</i>)</h3>
<p>This signal is emitted after the flag which specifies to restore the previous settings while closing the serial port has been changed. The new flag which specifies to restore the previous settings while closing the serial port is passed as <i>restore</i>.</p>
<p><b>Note:</b> Notifier signal for property <a href="qserialport-obsolete.html#settingsRestoredOnClose-prop">settingsRestoredOnClose</a>. </p><p><b>See also </b><a href="qserialport-obsolete.html#settingsRestoredOnClose-prop">QSerialPort::settingsRestoredOnClose</a>.</p>
<!-- @@@settingsRestoredOnCloseChanged -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2017 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br>    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.<br>    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. </p>
</div>
</body>
</html>