mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-05 09:44:00 +01:00
111 lines
12 KiB
HTML
111 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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.7"/>
|
|
<title>API: NexText.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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">NexText.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_nex_text_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> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "<a class="code" href="_nex_text_8h.html">NexText.h</a>"</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_nex_text.html#ab199d12188a48e5f92844452ebd493cc"> 22</a></span> <a class="code" href="class_nex_text.html#ab199d12188a48e5f92844452ebd493cc">NexText::NexText</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>  :<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> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> }</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="class_nex_text.html#a9cf417b2f25df2872492c55bdc9f5b30"> 35</a></span> uint16_t <a class="code" href="class_nex_text.html#a9cf417b2f25df2872492c55bdc9f5b30">NexText::getText</a>(<span class="keywordtype">char</span> *buffer, uint16_t len)</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  String cmd;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  cmd += <span class="stringliteral">"get "</span>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  cmd += <a class="code" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a>();</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  cmd += <span class="stringliteral">".txt"</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a>(cmd.c_str());</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> <a class="code" href="class_nex_touch.html#ac9cf23a7fc63040dc129ac3cb3de1d35">recvRetString</a>(buffer,len);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> }</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_nex_text.html#a19589b32c981436a1bbcfe407bc766e3"> 53</a></span> <span class="keywordtype">bool</span> <a class="code" href="class_nex_text.html#a19589b32c981436a1bbcfe407bc766e3">NexText::setText</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer)</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  String cmd;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  cmd += <a class="code" href="class_nex_touch.html#a31e2d5f2922383f8d82c33f7586643d0">getObjName</a>();</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  cmd += <span class="stringliteral">".txt=\""</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  cmd += buffer;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  cmd += <span class="stringliteral">"\""</span>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="class_nex_touch.html#a822897068e62ae76bee9824de1ef85a8">sendCommand</a>(cmd.c_str());</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> <a class="code" href="class_nex_touch.html#a9129f708be2b8f7fd417803025e83507">recvRetCommandFinished</a>(); </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="class_nex_text.html#a65afd4e50e90d325dc990434fd0582d4"> 70</a></span> <span class="keywordtype">void</span> <a class="code" href="class_nex_text.html#a65afd4e50e90d325dc990434fd0582d4">NexText::attachPop</a>(NexTouchEventCb pop, <span class="keywordtype">void</span> *ptr)</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  NexTouch::attachPop(pop, ptr);</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="class_nex_text.html#a9b718af186036890749c2f0951be9928"> 79</a></span> <span class="keywordtype">void</span> <a class="code" href="class_nex_text.html#a9b718af186036890749c2f0951be9928">NexText::detachPop</a>(<span class="keywordtype">void</span>)</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> {</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  NexTouch::detachPop(); </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> }</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="ttc" id="class_nex_text_html_a19589b32c981436a1bbcfe407bc766e3"><div class="ttname"><a href="class_nex_text.html#a19589b32c981436a1bbcfe407bc766e3">NexText::setText</a></div><div class="ttdeci">bool setText(const char *buffer)</div><div class="ttdoc">Set the value of text. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_text_8cpp_source.html#l00053">NexText.cpp:53</a></div></div>
|
|
<div class="ttc" id="class_nex_text_html_a9b718af186036890749c2f0951be9928"><div class="ttname"><a href="class_nex_text.html#a9b718af186036890749c2f0951be9928">NexText::detachPop</a></div><div class="ttdeci">void detachPop(void)</div><div class="ttdoc">Unload text pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_text_8cpp_source.html#l00079">NexText.cpp:79</a></div></div>
|
|
<div class="ttc" id="_nex_text_8h_html"><div class="ttname"><a href="_nex_text_8h.html">NexText.h</a></div><div class="ttdoc">API of NexText. </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="class_nex_text_html_a9cf417b2f25df2872492c55bdc9f5b30"><div class="ttname"><a href="class_nex_text.html#a9cf417b2f25df2872492c55bdc9f5b30">NexText::getText</a></div><div class="ttdeci">uint16_t getText(char *buffer, uint16_t len)</div><div class="ttdoc">Get the value of text. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_text_8cpp_source.html#l00035">NexText.cpp:35</a></div></div>
|
|
<div class="ttc" id="class_nex_text_html_ab199d12188a48e5f92844452ebd493cc"><div class="ttname"><a href="class_nex_text.html#ab199d12188a48e5f92844452ebd493cc">NexText::NexText</a></div><div class="ttdeci">NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)</div><div class="ttdoc">Constructor,inherited NexTouch's constructor function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_text_8cpp_source.html#l00022">NexText.cpp:22</a></div></div>
|
|
<div class="ttc" id="class_nex_touch_html_ac9cf23a7fc63040dc129ac3cb3de1d35"><div class="ttname"><a href="class_nex_touch.html#ac9cf23a7fc63040dc129ac3cb3de1d35">NexTouch::recvRetString</a></div><div class="ttdeci">static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)</div><div class="ttdoc">Receive string data. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_touch_8cpp_source.html#l00279">NexTouch.cpp:279</a></div></div>
|
|
<div class="ttc" id="class_nex_text_html_a65afd4e50e90d325dc990434fd0582d4"><div class="ttname"><a href="class_nex_text.html#a65afd4e50e90d325dc990434fd0582d4">NexText::attachPop</a></div><div class="ttdeci">void attachPop(NexTouchEventCb pop, void *ptr=NULL)</div><div class="ttdoc">Register text pop callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_nex_text_8cpp_source.html#l00070">NexText.cpp:70</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|