mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-03 08:44:00 +01:00
254 lines
19 KiB
HTML
254 lines
19 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 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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_nex_text-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NexText Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="class_nex_text.html" title="NexText,subclass of NexTouch,provides simple methods to control text component. ">NexText</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control text component.
|
|
<a href="class_nex_text.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_nex_text_8h_source.html">NexText.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for NexText:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_nex_text.png" usemap="#NexText_map" alt=""/>
|
|
<map id="NexText_map" name="NexText_map">
|
|
<area href="class_nex_touch.html" title="Root Class of Nextion Components. " alt="NexTouch" shape="rect" coords="0,0,69,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:ab199d12188a48e5f92844452ebd493cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab199d12188a48e5f92844452ebd493cc"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html#ab199d12188a48e5f92844452ebd493cc">NexText</a> (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)</td></tr>
|
|
<tr class="memdesc:ab199d12188a48e5f92844452ebd493cc"><td class="mdescLeft"> </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:ab199d12188a48e5f92844452ebd493cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65afd4e50e90d325dc990434fd0582d4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html#a65afd4e50e90d325dc990434fd0582d4">attachPop</a> (NexTouchEventCb pop, void *ptr=NULL)</td></tr>
|
|
<tr class="memdesc:a65afd4e50e90d325dc990434fd0582d4"><td class="mdescLeft"> </td><td class="mdescRight">Register text pop callback function. <a href="#a65afd4e50e90d325dc990434fd0582d4">More...</a><br /></td></tr>
|
|
<tr class="separator:a65afd4e50e90d325dc990434fd0582d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b718af186036890749c2f0951be9928"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b718af186036890749c2f0951be9928"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html#a9b718af186036890749c2f0951be9928">detachPop</a> (void)</td></tr>
|
|
<tr class="memdesc:a9b718af186036890749c2f0951be9928"><td class="mdescLeft"> </td><td class="mdescRight">Unload text pop callback function. <br /></td></tr>
|
|
<tr class="separator:a9b718af186036890749c2f0951be9928"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cf417b2f25df2872492c55bdc9f5b30"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html#a9cf417b2f25df2872492c55bdc9f5b30">getText</a> (char *buffer, uint16_t len)</td></tr>
|
|
<tr class="memdesc:a9cf417b2f25df2872492c55bdc9f5b30"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of text. <a href="#a9cf417b2f25df2872492c55bdc9f5b30">More...</a><br /></td></tr>
|
|
<tr class="separator:a9cf417b2f25df2872492c55bdc9f5b30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19589b32c981436a1bbcfe407bc766e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html#a19589b32c981436a1bbcfe407bc766e3">setText</a> (const char *buffer)</td></tr>
|
|
<tr class="memdesc:a19589b32c981436a1bbcfe407bc766e3"><td class="mdescLeft"> </td><td class="mdescRight">Set the value of text. <a href="#a19589b32c981436a1bbcfe407bc766e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a19589b32c981436a1bbcfe407bc766e3"><td class="memSeparator" colspan="2"> </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="-"/> 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"> </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"> </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"> </td></tr>
|
|
<tr class="memitem:a2aaea7a401a6fef25aafafc2f06b8339 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">NexPid </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"> </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"> </td></tr>
|
|
<tr class="memitem:a3d769351baa4eac31b0063949e469469 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">NexCid </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"> </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"> </td></tr>
|
|
<tr class="memitem:a31e2d5f2922383f8d82c33f7586643d0 inherit pub_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">const char * </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"> </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"> </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 </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"> </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"> </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="-"/> 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 </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"> </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"> </td></tr>
|
|
<tr class="memitem:a822897068e62ae76bee9824de1ef85a8 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static void </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"> </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"> </td></tr>
|
|
<tr class="memitem:a9129f708be2b8f7fd417803025e83507 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static bool </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"> </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"> </td></tr>
|
|
<tr class="memitem:ac9cf23a7fc63040dc129ac3cb3de1d35 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static uint16_t </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"> </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"> </td></tr>
|
|
<tr class="memitem:a257439b0ce23b3b2de73fad3944d5336 inherit pub_static_methods_class_nex_touch"><td class="memItemLeft" align="right" valign="top">static bool </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"> </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"> </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_text.html" title="NexText,subclass of NexTouch,provides simple methods to control text component. ">NexText</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control text component. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_text_8h_source.html#l00025">25</a> of file <a class="el" href="_nex_text_8h_source.html">NexText.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a65afd4e50e90d325dc990434fd0582d4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NexText::attachPop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">NexTouchEventCb </td>
|
|
<td class="paramname"><em>pop</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ptr</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register text pop callback function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pop</td><td>- the pointer to text pop callback function. </td></tr>
|
|
<tr><td class="paramname">ptr</td><td>- the parameter to be transmitted to text pop callback function. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_text_8cpp_source.html#l00070">70</a> of file <a class="el" href="_nex_text_8cpp_source.html">NexText.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9cf417b2f25df2872492c55bdc9f5b30"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t NexText::getText </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the value of text. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>- text value buffer. </td></tr>
|
|
<tr><td class="paramname">len</td><td>- the length of text value buffer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the the length of text value buffer. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_text_8cpp_source.html#l00035">35</a> of file <a class="el" href="_nex_text_8cpp_source.html">NexText.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a19589b32c981436a1bbcfe407bc766e3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool NexText::setText </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>buffer</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the value of text. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>- text value buffer.</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_text_8cpp_source.html#l00053">53</a> of file <a class="el" href="_nex_text_8cpp_source.html">NexText.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_nex_text_8h_source.html">NexText.h</a></li>
|
|
<li><a class="el" href="_nex_text_8cpp_source.html">NexText.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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|