Mirrors/ITEADLIB_Arduino_Nextion
2
0
Fork 0
mirror of https://github.com/itead/ITEADLIB_Arduino_Nextion.git synced 2026-03-03 08:44:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add doc and doxygen config file.

Browse Source
This commit is contained in:
zhanglaicheng
2015-07-16 10:41:50 +08:00
parent eaad704b5d
commit f43f8f8ef6
132 changed files with 14103 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
doc/API-html/class_nex_pointer.html Normal file
View File

@@ -0,0 +1,204 @@
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>API: NexPointer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ITEAD-logo.JPG"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">API
</div>
<div id="projectbrief">For Arduino developers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nex_pointer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NexPointer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_nex_pointer.html" title="NexPointer,subclass of NexTouch,provides simple methods to control pointer component. ">NexPointer</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control pointer component.
<a href="class_nex_pointer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nex_pointer_8h_source.html">NexPointer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for NexPointer:</div>
<div class="dyncontent">
<div class="center">
<img src="class_nex_pointer.png" usemap="#NexPointer_map" alt=""/>
<map id="NexPointer_map" name="NexPointer_map">
<area href="class_nex_touch.html" title="Root Class of Nextion Components. " alt="NexTouch" shape="rect" coords="0,0,74,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a354eb8a9750b734cadd66d079a47e712"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a354eb8a9750b734cadd66d079a47e712"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_pointer.html#a354eb8a9750b734cadd66d079a47e712">NexPointer</a> (NexPid pid, NexCid cid, char *name)</td></tr>
<tr class="memdesc:a354eb8a9750b734cadd66d079a47e712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor,inherited <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>'s constructor function. <br /></td></tr>
<tr class="separator:a354eb8a9750b734cadd66d079a47e712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d061972b36c952732c34ccfa3e506e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_pointer.html#a9d061972b36c952732c34ccfa3e506e3">getValue</a> (uint32_t *number)</td></tr>
<tr class="memdesc:a9d061972b36c952732c34ccfa3e506e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of pointer. <a href="#a9d061972b36c952732c34ccfa3e506e3">More...</a><br /></td></tr>
<tr class="separator:a9d061972b36c952732c34ccfa3e506e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d6dd483961e23a83219e5bc884a2600"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_pointer.html#a5d6dd483961e23a83219e5bc884a2600">setValue</a> (uint32_t number)</td></tr>
<tr class="memdesc:a5d6dd483961e23a83219e5bc884a2600"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the value of pointer. <a href="#a5d6dd483961e23a83219e5bc884a2600">More...</a><br /></td></tr>
<tr class="separator:a5d6dd483961e23a83219e5bc884a2600"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_nex_touch"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_nex_touch')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_nex_touch.html">NexTouch</a></td></tr>
<tr class="memitem:a1cf4b76cda45ef6517f6d07f86c8018d inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a1cf4b76cda45ef6517f6d07f86c8018d">NexTouch</a> (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)</td></tr>
<tr class="memdesc:a1cf4b76cda45ef6517f6d07f86c8018d inherit pub_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor of Nextouch. <a href="#a1cf4b76cda45ef6517f6d07f86c8018d">More...</a><br /></td></tr>
<tr class="separator:a1cf4b76cda45ef6517f6d07f86c8018d inherit pub_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2aaea7a401a6fef25aafafc2f06b8339 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">NexPid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a2aaea7a401a6fef25aafafc2f06b8339">getPid</a> (void)</td></tr>
<tr class="memdesc:a2aaea7a401a6fef25aafafc2f06b8339 inherit pub_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get page id. <a href="#a2aaea7a401a6fef25aafafc2f06b8339">More...</a><br /></td></tr>
<tr class="separator:a2aaea7a401a6fef25aafafc2f06b8339 inherit pub_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d769351baa4eac31b0063949e469469 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">NexCid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a3d769351baa4eac31b0063949e469469">getCid</a> (void)</td></tr>
<tr class="memdesc:a3d769351baa4eac31b0063949e469469 inherit pub_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get component id. <a href="#a3d769351baa4eac31b0063949e469469">More...</a><br /></td></tr>
<tr class="separator:a3d769351baa4eac31b0063949e469469 inherit pub_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e2d5f2922383f8d82c33f7586643d0 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a> (void)</td></tr>
<tr class="memdesc:a31e2d5f2922383f8d82c33f7586643d0 inherit pub_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get component name. <a href="#a31e2d5f2922383f8d82c33f7586643d0">More...</a><br /></td></tr>
<tr class="separator:a31e2d5f2922383f8d82c33f7586643d0 inherit pub_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f4c8a51d930403413d1f267348a9a1e inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f4c8a51d930403413d1f267348a9a1e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a5f4c8a51d930403413d1f267348a9a1e">print</a> (void)</td></tr>
<tr class="memdesc:a5f4c8a51d930403413d1f267348a9a1e inherit pub_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print current object address,page id,component id, component name,pop event function address,push event function address. <br /></td></tr>
<tr class="separator:a5f4c8a51d930403413d1f267348a9a1e inherit pub_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_class_nex_touch"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_nex_touch')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_nex_touch.html">NexTouch</a></td></tr>
<tr class="memitem:a48db410f610f36196752633bf3d013ce inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a48db410f610f36196752633bf3d013ce">mainEventLoop</a> (<a class="el" href="class_nex_touch.html">NexTouch</a> **list)</td></tr>
<tr class="memdesc:a48db410f610f36196752633bf3d013ce inherit pub_static_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Watting for Nextion's touch event. <a href="#a48db410f610f36196752633bf3d013ce">More...</a><br /></td></tr>
<tr class="separator:a48db410f610f36196752633bf3d013ce inherit pub_static_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a822897068e62ae76bee9824de1ef85a8 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a> (const char *cmd)</td></tr>
<tr class="memdesc:a822897068e62ae76bee9824de1ef85a8 inherit pub_static_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send command to Nextion. <a href="#a822897068e62ae76bee9824de1ef85a8">More...</a><br /></td></tr>
<tr class="separator:a822897068e62ae76bee9824de1ef85a8 inherit pub_static_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9129f708be2b8f7fd417803025e83507 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a9129f708be2b8f7fd417803025e83507">recvRetCommandFinished</a> (uint32_t timeout=100)</td></tr>
<tr class="memdesc:a9129f708be2b8f7fd417803025e83507 inherit pub_static_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command is executed successfully. <a href="#a9129f708be2b8f7fd417803025e83507">More...</a><br /></td></tr>
<tr class="separator:a9129f708be2b8f7fd417803025e83507 inherit pub_static_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9cf23a7fc63040dc129ac3cb3de1d35 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#ac9cf23a7fc63040dc129ac3cb3de1d35">recvRetString</a> (char *buffer, uint16_t len, uint32_t timeout=500)</td></tr>
<tr class="memdesc:ac9cf23a7fc63040dc129ac3cb3de1d35 inherit pub_static_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive string data. <a href="#ac9cf23a7fc63040dc129ac3cb3de1d35">More...</a><br /></td></tr>
<tr class="separator:ac9cf23a7fc63040dc129ac3cb3de1d35 inherit pub_static_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a257439b0ce23b3b2de73fad3944d5336 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a257439b0ce23b3b2de73fad3944d5336">recvRetNumber</a> (uint32_t *number, uint32_t timeout=500)</td></tr>
<tr class="memdesc:a257439b0ce23b3b2de73fad3944d5336 inherit pub_static_methods_class_nex_touch"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive uint32_t data. <a href="#a257439b0ce23b3b2de73fad3944d5336">More...</a><br /></td></tr>
<tr class="separator:a257439b0ce23b3b2de73fad3944d5336 inherit pub_static_methods_class_nex_touch"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_nex_pointer.html" title="NexPointer,subclass of NexTouch,provides simple methods to control pointer component. ">NexPointer</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control pointer component. </p>
<p>Definition at line <a class="el" href="_nex_pointer_8h_source.html#l00010">10</a> of file <a class="el" href="_nex_pointer_8h_source.html">NexPointer.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9d061972b36c952732c34ccfa3e506e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NexPointer::getValue </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>number</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>- an output parameter to save pointer's value.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>- success. </td></tr>
<tr><td class="paramname">false</td><td>- failed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_pointer_8cpp_source.html#l00020">20</a> of file <a class="el" href="_nex_pointer_8cpp_source.html">NexPointer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5d6dd483961e23a83219e5bc884a2600"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NexPointer::setValue </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>number</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">number</td><td>- the value of pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>- success. </td></tr>
<tr><td class="paramname">false</td><td>- failed. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_pointer_8cpp_source.html#l00037">37</a> of file <a class="el" href="_nex_pointer_8cpp_source.html">NexPointer.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_nex_pointer_8h_source.html">NexPointer.h</a></li>
<li><a class="el" href="_nex_pointer_8cpp_source.html">NexPointer.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 16 2015 10:37:57 for API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>