update document

This commit is contained in:
zhanglaicheng
2015-07-29 13:20:26 +08:00
parent 8c0d6ad2a0
commit 0b376836e2
141 changed files with 14189 additions and 0 deletions

View File

@@ -0,0 +1,102 @@
<!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: NexPage.cpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">NexPage.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_nex_page_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_nex_page_8h.html">NexPage.h</a>&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_nex_page.html#a5165f40ae2278291edf0f1876ea883f9"> 22</a></span>&#160;<a class="code" href="class_nex_page.html#a5165f40ae2278291edf0f1876ea883f9">NexPage::NexPage</a>(NexPid pid, NexCid cid, <span class="keywordtype">char</span> *name, NexTouchEventCb pop, <span class="keywordtype">void</span> *pop_ptr)</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; :<a class="code" href="class_nex_touch.html">NexTouch</a>(pid, cid, name, pop, pop_ptr)</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;}</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="class_nex_page.html#a5714e41d4528b991eda4bbe578005418"> 33</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_nex_page.html#a5714e41d4528b991eda4bbe578005418">NexPage::show</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint8_t buffer[4] = {0};</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name = <a class="code" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span> (!name)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; String cmd = String(<span class="stringliteral">&quot;page &quot;</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; cmd += name;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a>(cmd.c_str());</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_nex_touch.html#a9129f708be2b8f7fd417803025e83507">recvRetCommandFinished</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="class_nex_page.html#a12dfab060db8a063ec37cc03d423bfa5"> 55</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_nex_page.html#a12dfab060db8a063ec37cc03d423bfa5">NexPage::attachPop</a>(NexTouchEventCb pop, <span class="keywordtype">void</span> *ptr)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; NexTouch::attachPop(pop, ptr);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="class_nex_page.html#ab54d1381b54798333de6035ce2fe76b2"> 64</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_nex_page.html#ab54d1381b54798333de6035ce2fe76b2">NexPage::detachPop</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;{</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; NexTouch::detachPop(); </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;}</div>
<div class="ttc" id="class_nex_page_html_ab54d1381b54798333de6035ce2fe76b2"><div class="ttname"><a href="class_nex_page.html#ab54d1381b54798333de6035ce2fe76b2">NexPage::detachPop</a></div><div class="ttdeci">void detachPop(void)</div><div class="ttdoc">Unload page pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_page_8cpp_source.html#l00064">NexPage.cpp:64</a></div></div>
<div class="ttc" id="class_nex_page_html_a5714e41d4528b991eda4bbe578005418"><div class="ttname"><a href="class_nex_page.html#a5714e41d4528b991eda4bbe578005418">NexPage::show</a></div><div class="ttdeci">bool show(void)</div><div class="ttdoc">Change page. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_page_8cpp_source.html#l00033">NexPage.cpp:33</a></div></div>
<div class="ttc" id="class_nex_touch_html_a822897068e62ae76bee9824de1ef85a8"><div class="ttname"><a href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">NexTouch::sendCommand</a></div><div class="ttdeci">static void sendCommand(const char *cmd)</div><div class="ttdoc">Send command to Nextion. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8cpp_source.html#l00256">NexTouch.cpp:256</a></div></div>
<div class="ttc" id="class_nex_touch_html_a31e2d5f2922383f8d82c33f7586643d0"><div class="ttname"><a href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">NexTouch::getObjName</a></div><div class="ttdeci">const char * getObjName(void)</div><div class="ttdoc">Get component name. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8cpp_source.html#l00107">NexTouch.cpp:107</a></div></div>
<div class="ttc" id="_nex_page_8h_html"><div class="ttname"><a href="_nex_page_8h.html">NexPage.h</a></div><div class="ttdoc">API of NexPage. </div></div>
<div class="ttc" id="class_nex_page_html_a5165f40ae2278291edf0f1876ea883f9"><div class="ttname"><a href="class_nex_page.html#a5165f40ae2278291edf0f1876ea883f9">NexPage::NexPage</a></div><div class="ttdeci">NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)</div><div class="ttdoc">Constructor,inherited NexTouch&#39;s constructor function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_page_8cpp_source.html#l00022">NexPage.cpp:22</a></div></div>
<div class="ttc" id="class_nex_page_html_a12dfab060db8a063ec37cc03d423bfa5"><div class="ttname"><a href="class_nex_page.html#a12dfab060db8a063ec37cc03d423bfa5">NexPage::attachPop</a></div><div class="ttdeci">void attachPop(NexTouchEventCb pop, void *ptr=NULL)</div><div class="ttdoc">Register page pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_page_8cpp_source.html#l00055">NexPage.cpp:55</a></div></div>
<div class="ttc" id="class_nex_touch_html_a9129f708be2b8f7fd417803025e83507"><div class="ttname"><a href="class_nex_touch.html#a9129f708be2b8f7fd417803025e83507">NexTouch::recvRetCommandFinished</a></div><div class="ttdeci">static bool recvRetCommandFinished(uint32_t timeout=100)</div><div class="ttdoc">Command is executed successfully. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8cpp_source.html#l00219">NexTouch.cpp:219</a></div></div>
<div class="ttc" id="class_nex_touch_html"><div class="ttname"><a href="class_nex_touch.html">NexTouch</a></div><div class="ttdoc">Root Class of Nextion Components. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8h_source.html#l00057">NexTouch.h:57</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 29 2015 13:08:59 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>