Files
ITEADLIB_Arduino_Nextion/doc/API-html/class_nex_button.html
zhanglaicheng d307735785 update document
2015-07-29 13:58:00 +08:00

258 lines
20 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: NexButton 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_button-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NexButton Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="class_nex_button.html" title="NexButton,subclass of NexTouch,provides simple methods to control button component. ">NexButton</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control button component.
<a href="class_nex_button.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nex_button_8h_source.html">NexButton.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for NexButton:</div>
<div class="dyncontent">
<div class="center">
<img src="class_nex_button.png" usemap="#NexButton_map" alt=""/>
<map id="NexButton_map" name="NexButton_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:a9776e1dc3cbb4af357f8d2a2924a7318"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9776e1dc3cbb4af357f8d2a2924a7318"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html#a9776e1dc3cbb4af357f8d2a2924a7318">NexButton</a> (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)</td></tr>
<tr class="memdesc:a9776e1dc3cbb4af357f8d2a2924a7318"><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:a9776e1dc3cbb4af357f8d2a2924a7318"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7d60c2339b8c4530349fe2e75b840d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html#a6c7d60c2339b8c4530349fe2e75b840d">attachPop</a> (NexTouchEventCb pop, void *ptr=NULL)</td></tr>
<tr class="memdesc:a6c7d60c2339b8c4530349fe2e75b840d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register button pop callback function. <a href="#a6c7d60c2339b8c4530349fe2e75b840d">More...</a><br /></td></tr>
<tr class="separator:a6c7d60c2339b8c4530349fe2e75b840d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c3cc5751cffade5be8fa05be88cd919"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c3cc5751cffade5be8fa05be88cd919"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html#a9c3cc5751cffade5be8fa05be88cd919">detachPop</a> (void)</td></tr>
<tr class="memdesc:a9c3cc5751cffade5be8fa05be88cd919"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unload button pop callback function. <br /></td></tr>
<tr class="separator:a9c3cc5751cffade5be8fa05be88cd919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ba1f74aa94b41b98172e42583ee13d6"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html#a5ba1f74aa94b41b98172e42583ee13d6">getText</a> (char *buffer, uint16_t len)</td></tr>
<tr class="memdesc:a5ba1f74aa94b41b98172e42583ee13d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get text value from button component. <a href="#a5ba1f74aa94b41b98172e42583ee13d6">More...</a><br /></td></tr>
<tr class="separator:a5ba1f74aa94b41b98172e42583ee13d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a649dafc5afb1dc7f1fc1bde1e6270290"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html#a649dafc5afb1dc7f1fc1bde1e6270290">setText</a> (const char *buffer)</td></tr>
<tr class="memdesc:a649dafc5afb1dc7f1fc1bde1e6270290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set text value of button component. <a href="#a649dafc5afb1dc7f1fc1bde1e6270290">More...</a><br /></td></tr>
<tr class="separator:a649dafc5afb1dc7f1fc1bde1e6270290"><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_button.html" title="NexButton,subclass of NexTouch,provides simple methods to control button component. ">NexButton</a>,subclass of <a class="el" href="class_nex_touch.html" title="Root Class of Nextion Components. ">NexTouch</a>,provides simple methods to control button component. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_comp_button_8ino-example.html#_a0">CompButton.ino</a>, <a class="el" href="_comp_pointer_8ino-example.html#_a1">CompPointer.ino</a>, <a class="el" href="_comp_progress_bar_8ino-example.html#_a1">CompProgressBar.ino</a>, and <a class="el" href="_comp_text_8ino-example.html#_a1">CompText.ino</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_button_8h_source.html#l00025">25</a> of file <a class="el" href="_nex_button_8h_source.html">NexButton.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6c7d60c2339b8c4530349fe2e75b840d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NexButton::attachPop </td>
<td>(</td>
<td class="paramtype">NexTouchEventCb&#160;</td>
<td class="paramname"><em>pop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em> = <code>NULL</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register button pop callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pop</td><td>- the pointer to button pop callback function. </td></tr>
<tr><td class="paramname">ptr</td><td>- the parameter to be transmitted to button pop callback function. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_comp_button_8ino-example.html#a5">CompButton.ino</a>, <a class="el" href="_comp_pointer_8ino-example.html#a6">CompPointer.ino</a>, and <a class="el" href="_comp_progress_bar_8ino-example.html#a6">CompProgressBar.ino</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_button_8cpp_source.html#l00070">70</a> of file <a class="el" href="_nex_button_8cpp_source.html">NexButton.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5ba1f74aa94b41b98172e42583ee13d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t NexButton::getText </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get text value from button component. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>- text buffer. </td></tr>
<tr><td class="paramname">len</td><td>- text buffer length.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the text buffer length </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_comp_button_8ino-example.html#a2">CompButton.ino</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_button_8cpp_source.html#l00035">35</a> of file <a class="el" href="_nex_button_8cpp_source.html">NexButton.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a649dafc5afb1dc7f1fc1bde1e6270290"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NexButton::setText </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set text value of button component. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>- text 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>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_comp_button_8ino-example.html#a3">CompButton.ino</a>.</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_button_8cpp_source.html#l00053">53</a> of file <a class="el" href="_nex_button_8cpp_source.html">NexButton.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_nex_button_8h_source.html">NexButton.h</a></li>
<li><a class="el" href="_nex_button_8cpp_source.html">NexButton.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 29 2015 13:48:32 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>