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

update document

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

126
API-html/_nex_crop_8cpp_source.html Normal file
View File

@@ -0,0 +1,126 @@
<!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: NexCrop.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">NexCrop.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_nex_crop_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_crop_8h.html">NexCrop.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_crop.html#af010e5bb401c7c3640f091a8a870a6ef"> 22</a></span>&#160;<a class="code" href="class_nex_crop.html#af010e5bb401c7c3640f091a8a870a6ef">NexCrop::NexCrop</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="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * Get the number of picture. </span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * @param number - an output parameter to save the number of picture. </span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> * @retval true - success. </span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> * @retval false - failed. </span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keywordtype">bool</span> NexCrop::getPic(uint32_t *number)</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; String cmd = String(<span class="stringliteral">&quot;get &quot;</span>);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; cmd += <a class="code" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; cmd += <span class="stringliteral">&quot;.picc&quot;</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a>(cmd.c_str());</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_nex_touch.html#a257439b0ce23b3b2de73fad3944d5336">recvRetNumber</a>(number);</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;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> * Set the number of picture. </span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> * @param number - the number of picture. </span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> * @retval true - success. </span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> * @retval false - failed. </span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">bool</span> NexCrop::setPic(uint32_t number)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">char</span> buf[10] = {0};</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; String cmd;</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; utoa(number, buf, 10);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; cmd += <a class="code" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a>();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; cmd += <span class="stringliteral">&quot;.picc=&quot;</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; cmd += buf;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <a class="code" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a>(cmd.c_str());</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> <a class="code" href="class_nex_touch.html#a9129f708be2b8f7fd417803025e83507">recvRetCommandFinished</a>();</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;}</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="class_nex_crop.html#a38c9d4d8999fd300ce4986743c016427"> 72</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_nex_crop.html#a38c9d4d8999fd300ce4986743c016427">NexCrop::attachPop</a>(NexTouchEventCb pop, <span class="keywordtype">void</span> *ptr)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; NexTouch::attachPop(pop, ptr);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="class_nex_crop.html#a11dda043a57eb4ca1831d1d0593dc8f0"> 81</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="class_nex_crop.html#a11dda043a57eb4ca1831d1d0593dc8f0">NexCrop::detachPop</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;{</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; NexTouch::detachPop(); </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
<div class="ttc" id="class_nex_crop_html_af010e5bb401c7c3640f091a8a870a6ef"><div class="ttname"><a href="class_nex_crop.html#af010e5bb401c7c3640f091a8a870a6ef">NexCrop::NexCrop</a></div><div class="ttdeci">NexCrop(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_crop_8cpp_source.html#l00022">NexCrop.cpp:22</a></div></div>
<div class="ttc" id="class_nex_crop_html_a11dda043a57eb4ca1831d1d0593dc8f0"><div class="ttname"><a href="class_nex_crop.html#a11dda043a57eb4ca1831d1d0593dc8f0">NexCrop::detachPop</a></div><div class="ttdeci">void detachPop(void)</div><div class="ttdoc">Unload crop pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_crop_8cpp_source.html#l00081">NexCrop.cpp:81</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_crop_8h_html"><div class="ttname"><a href="_nex_crop_8h.html">NexCrop.h</a></div><div class="ttdoc">API of NexCrop. </div></div>
<div class="ttc" id="class_nex_crop_html_a38c9d4d8999fd300ce4986743c016427"><div class="ttname"><a href="class_nex_crop.html#a38c9d4d8999fd300ce4986743c016427">NexCrop::attachPop</a></div><div class="ttdeci">void attachPop(NexTouchEventCb pop, void *ptr=NULL)</div><div class="ttdoc">Register crop pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_crop_8cpp_source.html#l00072">NexCrop.cpp:72</a></div></div>
<div class="ttc" id="class_nex_touch_html_a257439b0ce23b3b2de73fad3944d5336"><div class="ttname"><a href="class_nex_touch.html#a257439b0ce23b3b2de73fad3944d5336">NexTouch::recvRetNumber</a></div><div class="ttdeci">static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)</div><div class="ttdoc">Receive uint32_t data. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8cpp_source.html#l00351">NexTouch.cpp:351</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>