mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-04 17:24:03 +01:00
252 lines
13 KiB
HTML
252 lines
13 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: NexTouch 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="Logo.png"/></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="modules.html"><span>Modules</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_touch-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NexTouch Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Root Class of Nextion Components.
|
|
<a href="class_nex_touch.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_nex_touch_8h_source.html">NexTouch.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for NexTouch:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_nex_touch.png" usemap="#NexTouch_map" alt=""/>
|
|
<map id="NexTouch_map" name="NexTouch_map">
|
|
<area href="class_nex_button.html" title="NexButton,subclass of NexTouch,provides simple methods to control button component. " alt="NexButton" shape="rect" coords="115,56,220,80"/>
|
|
<area href="class_nex_crop.html" title="NexCrop,subclass of NexTouch,provides simple methods to control crop component. " alt="NexCrop" shape="rect" coords="115,112,220,136"/>
|
|
<area href="class_nex_gauge.html" title="NexGauge,subclass of NexTouch,provides simple methods to control gauge component. ..." alt="NexGauge" shape="rect" coords="115,168,220,192"/>
|
|
<area href="class_nex_hotspot.html" title="NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component. " alt="NexHotspot" shape="rect" coords="115,224,220,248"/>
|
|
<area href="class_nex_page.html" title="NexPage,subclass of NexTouch,provides simple methods to control page component. " alt="NexPage" shape="rect" coords="115,280,220,304"/>
|
|
<area href="class_nex_picture.html" title="NexPicture,subclass of NexTouch,provides simple methods to control picture component. " alt="NexPicture" shape="rect" coords="115,336,220,360"/>
|
|
<area href="class_nex_progress_bar.html" title="NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component..." alt="NexProgressBar" shape="rect" coords="115,392,220,416"/>
|
|
<area href="class_nex_slider.html" title="NexSlider,subclass of NexTouch,provides simple methods to control slider component. " alt="NexSlider" shape="rect" coords="115,448,220,472"/>
|
|
<area href="class_nex_text.html" title="NexText,subclass of NexTouch,provides simple methods to control text component. " alt="NexText" shape="rect" coords="115,504,220,528"/>
|
|
<area href="class_nex_waveform.html" title="NexWaveform,subclass of NexTouch,provides simple methods to control NexWaveform component. " alt="NexWaveform" shape="rect" coords="115,560,220,584"/>
|
|
</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:a1cf4b76cda45ef6517f6d07f86c8018d"><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"><td class="mdescLeft"> </td><td class="mdescRight">Constructor of Nextouch. <a href="#a1cf4b76cda45ef6517f6d07f86c8018d">More...</a><br /></td></tr>
|
|
<tr class="separator:a1cf4b76cda45ef6517f6d07f86c8018d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2aaea7a401a6fef25aafafc2f06b8339"><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"><td class="mdescLeft"> </td><td class="mdescRight">Get page id. <a href="#a2aaea7a401a6fef25aafafc2f06b8339">More...</a><br /></td></tr>
|
|
<tr class="separator:a2aaea7a401a6fef25aafafc2f06b8339"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d769351baa4eac31b0063949e469469"><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"><td class="mdescLeft"> </td><td class="mdescRight">Get component id. <a href="#a3d769351baa4eac31b0063949e469469">More...</a><br /></td></tr>
|
|
<tr class="separator:a3d769351baa4eac31b0063949e469469"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31e2d5f2922383f8d82c33f7586643d0"><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"><td class="mdescLeft"> </td><td class="mdescRight">Get component name. <a href="#a31e2d5f2922383f8d82c33f7586643d0">More...</a><br /></td></tr>
|
|
<tr class="separator:a31e2d5f2922383f8d82c33f7586643d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Root Class of Nextion Components. </p>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_comp_button_8ino-example.html#_a1">CompButton.ino</a>, <a class="el" href="_comp_crop_8ino-example.html#_a1">CompCrop.ino</a>, <a class="el" href="_comp_gauge_8ino-example.html#_a2">CompGauge.ino</a>, <a class="el" href="_comp_hotspot_8ino-example.html#_a1">CompHotspot.ino</a>, <a class="el" href="_comp_page_8ino-example.html#_a1">CompPage.ino</a>, <a class="el" href="_comp_picture_8ino-example.html#_a1">CompPicture.ino</a>, <a class="el" href="_comp_progress_bar_8ino-example.html#_a2">CompProgressBar.ino</a>, <a class="el" href="_comp_slider_8ino-example.html#_a2">CompSlider.ino</a>, and <a class="el" href="_comp_text_8ino-example.html#_a2">CompText.ino</a>.</dd>
|
|
</dl>
|
|
<p>Definition at line <a class="el" href="_nex_touch_8h_source.html#l00037">37</a> of file <a class="el" href="_nex_touch_8h_source.html">NexTouch.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a1cf4b76cda45ef6517f6d07f86c8018d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NexTouch::NexTouch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">NexPid </td>
|
|
<td class="paramname"><em>pid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">NexCid </td>
|
|
<td class="paramname"><em>cid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">NexTouchEventCb </td>
|
|
<td class="paramname"><em>pop</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>pop_ptr</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">NexTouchEventCb </td>
|
|
<td class="paramname"><em>push</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>push_ptr</em> = <code>NULL</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor of Nextouch. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pid</td><td>- page id. </td></tr>
|
|
<tr><td class="paramname">cid</td><td>- component id. </td></tr>
|
|
<tr><td class="paramname">name</td><td>- component name. </td></tr>
|
|
<tr><td class="paramname">pop</td><td>- pop event function pointer. </td></tr>
|
|
<tr><td class="paramname">pop_ptr</td><td>- the parameter was transmitted to pop event function pointer. </td></tr>
|
|
<tr><td class="paramname">push</td><td>- push event function pointer. </td></tr>
|
|
<tr><td class="paramname">push_ptr</td><td>- the parameter was transmitted to push event function pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_touch_8cpp_source.html#l00031">31</a> of file <a class="el" href="_nex_touch_8cpp_source.html">NexTouch.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a3d769351baa4eac31b0063949e469469"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NexCid NexTouch::getCid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get component id. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the id of component. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_touch_8cpp_source.html#l00059">59</a> of file <a class="el" href="_nex_touch_8cpp_source.html">NexTouch.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a31e2d5f2922383f8d82c33f7586643d0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const char * NexTouch::getObjName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get component name. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the name of component. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_touch_8cpp_source.html#l00069">69</a> of file <a class="el" href="_nex_touch_8cpp_source.html">NexTouch.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2aaea7a401a6fef25aafafc2f06b8339"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NexPid NexTouch::getPid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get page id. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the id of page. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_touch_8cpp_source.html#l00049">49</a> of file <a class="el" href="_nex_touch_8cpp_source.html">NexTouch.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_nex_touch_8h_source.html">NexTouch.h</a></li>
|
|
<li><a class="el" href="_nex_touch_8cpp_source.html">NexTouch.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Aug 12 2015 17:53:26 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>
|