ostinato/doxydocs/class_abstract_protocol_config_form.html
2015-07-22 19:05:24 +05:30

221 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>AbstractProtocolConfigForm Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<!-- Generated by Doxygen 1.7.5.1 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">AbstractProtocolConfigForm Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="AbstractProtocolConfigForm" -->
<p><a href="class_abstract_protocol_config_form-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a4ffb524289d0693f34f574320b6947e7">AbstractProtocolConfigForm</a> (QWidget *parent=0)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the widget. <a href="#a4ffb524289d0693f34f574320b6947e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a7fab8a8781cb39ea8c0aee0728512f38">~AbstractProtocolConfigForm</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the widget. <a href="#a7fab8a8781cb39ea8c0aee0728512f38"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a39410b5c5e4fc0fcf0b848d472868da3">loadWidget</a> (<a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads data from the protocol using it's fieldData() method into this widget. <a href="#a39410b5c5e4fc0fcf0b848d472868da3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90">storeWidget</a> (<a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores data from this widget into the protocol using the protocol's setFieldData() method. <a href="#a77a25bddb0310fee7ad4cd437fe95d90"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#af146c51184f181b25761512ccb6383c8">hexStrToUInt</a> (QString text, bool *ok=NULL)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol&#39;s setFieldData() method...">storeWidget()</a> implementations. <a href="#af146c51184f181b25761512ccb6383c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">quint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a2b875ffb5ef73914bada207043272232">hexStrToUInt64</a> (QString text, bool *ok=NULL)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol&#39;s setFieldData() method...">storeWidget()</a> implementations. <a href="#a2b875ffb5ef73914bada207043272232"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_abstract_protocol_config_form.html#a7fc940d0a24ab32d0ce7f940125831ae">createInstance</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates and returns a new instance of the widget. <a href="#a7fc940d0a24ab32d0ce7f940125831ae"></a><br/></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4ffb524289d0693f34f574320b6947e7"></a><!-- doxytag: member="AbstractProtocolConfigForm::AbstractProtocolConfigForm" ref="a4ffb524289d0693f34f574320b6947e7" args="(QWidget *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AbstractProtocolConfigForm::AbstractProtocolConfigForm </td>
<td>(</td>
<td class="paramtype">QWidget *&#160;</td>
<td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the widget. </p>
</div>
</div>
<a class="anchor" id="a7fab8a8781cb39ea8c0aee0728512f38"></a><!-- doxytag: member="AbstractProtocolConfigForm::~AbstractProtocolConfigForm" ref="a7fab8a8781cb39ea8c0aee0728512f38" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual AbstractProtocolConfigForm::~AbstractProtocolConfigForm </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroys the widget. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7fc940d0a24ab32d0ce7f940125831ae"></a><!-- doxytag: member="AbstractProtocolConfigForm::createInstance" ref="a7fc940d0a24ab32d0ce7f940125831ae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_abstract_protocol_config_form.html">AbstractProtocolConfigForm</a>* AbstractProtocolConfigForm::createInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocates and returns a new instance of the widget. </p>
<p>Caller is responsible for freeing up after use. Subclasses MUST implement this function </p>
</div>
</div>
<a class="anchor" id="af146c51184f181b25761512ccb6383c8"></a><!-- doxytag: member="AbstractProtocolConfigForm::hexStrToUInt" ref="af146c51184f181b25761512ccb6383c8" args="(QString text, bool *ok=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint AbstractProtocolConfigForm::hexStrToUInt </td>
<td>(</td>
<td class="paramtype">QString&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>ok</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol&#39;s setFieldData() method...">storeWidget()</a> implementations. </p>
</div>
</div>
<a class="anchor" id="a2b875ffb5ef73914bada207043272232"></a><!-- doxytag: member="AbstractProtocolConfigForm::hexStrToUInt64" ref="a2b875ffb5ef73914bada207043272232" args="(QString text, bool *ok=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">quint64 AbstractProtocolConfigForm::hexStrToUInt64 </td>
<td>(</td>
<td class="paramtype">QString&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>ok</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience Method - can be used by <a class="el" href="class_abstract_protocol_config_form.html#a77a25bddb0310fee7ad4cd437fe95d90" title="Stores data from this widget into the protocol using the protocol&#39;s setFieldData() method...">storeWidget()</a> implementations. </p>
</div>
</div>
<a class="anchor" id="a39410b5c5e4fc0fcf0b848d472868da3"></a><!-- doxytag: member="AbstractProtocolConfigForm::loadWidget" ref="a39410b5c5e4fc0fcf0b848d472868da3" args="(AbstractProtocol *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void AbstractProtocolConfigForm::loadWidget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *&#160;</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads data from the protocol using it's fieldData() method into this widget. </p>
<p>Any conversion to user friendly display/editing formats (e.g. hex format) SHOULD be done by this method.</p>
<p>Subclasses MUST implement this function. See the SampleProtocol for an example </p>
</div>
</div>
<a class="anchor" id="a77a25bddb0310fee7ad4cd437fe95d90"></a><!-- doxytag: member="AbstractProtocolConfigForm::storeWidget" ref="a77a25bddb0310fee7ad4cd437fe95d90" args="(AbstractProtocol *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void AbstractProtocolConfigForm::storeWidget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_abstract_protocol.html">AbstractProtocol</a> *&#160;</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores data from this widget into the protocol using the protocol's setFieldData() method. </p>
<p>Field values MUST be converted from any user friendly display/editing formats (e.g. hex format) to simple Qt-style integers/strings before passing to setFieldData()</p>
<p>Subclasses MUST implement this function. See the SampleProtocol for an example </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>common/abstractprotocolconfig.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:40:09 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>
</body>
</html>