Mirrors/ITEADLIB_Arduino_Nextion
2
0
Fork 0
mirror of https://github.com/itead/ITEADLIB_Arduino_Nextion.git synced 2026-03-06 02:04:06 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
bd2795245ddf040de9b1dddf07dc1aecda82ca6d
ITEADLIB_Arduino_Nextion/doc/UserManual/group___nextion.html
shennongmin 7e1fbe15bb Update docs. 
Signed-off-by: shennongmin <wupangfee@gmail.com>
2015-08-14 17:43:48 +08:00

203 lines
15 KiB
HTML
Raw Blame History

<!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>Nextion User Manual: Nextion Component</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">Nextion User Manual
</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="modules.html"><span>Modules</span></a></li>
<li><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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Nextion Component</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_button.html">NexButton</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_button.html" title="NexButton component. ">NexButton</a> component. <a href="class_nex_button.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_crop.html">NexCrop</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_crop.html" title="NexCrop component. ">NexCrop</a> component. <a href="class_nex_crop.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_gauge.html">NexGauge</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_gauge.html" title="NexGauge component. ">NexGauge</a> component. <a href="class_nex_gauge.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_hotspot.html">NexHotspot</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_hotspot.html" title="NexHotspot component. ">NexHotspot</a> component. <a href="class_nex_hotspot.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html">NexObject</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Root class of all Nextion components. <a href="class_nex_object.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_page.html">NexPage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A special component , which can contain other components such as <a class="el" href="class_nex_button.html" title="NexButton component. ">NexButton</a>, <a class="el" href="class_nex_text.html" title="NexText component. ">NexText</a> and <a class="el" href="class_nex_waveform.html" title="NexWaveform component. ">NexWaveform</a>, etc. <a href="class_nex_page.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_picture.html">NexPicture</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_picture.html" title="NexPicture component. ">NexPicture</a> component. <a href="class_nex_picture.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_progress_bar.html">NexProgressBar</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_progress_bar.html" title="NexProgressBar component. ">NexProgressBar</a> component. <a href="class_nex_progress_bar.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_slider.html">NexSlider</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_slider.html" title="NexSlider component. ">NexSlider</a> component. <a href="class_nex_slider.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_text.html">NexText</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_text.html" title="NexText component. ">NexText</a> component. <a href="class_nex_text.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html">NexTouch</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Father class of the components with touch events. <a href="class_nex_touch.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_waveform.html">NexWaveform</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_nex_waveform.html" title="NexWaveform component. ">NexWaveform</a> component. <a href="class_nex_waveform.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga748c37a9bbe04ddc680fe1686154fefb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga748c37a9bbe04ddc680fe1686154fefb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#ga748c37a9bbe04ddc680fe1686154fefb">NEX_EVENT_PUSH</a>&#160;&#160;&#160;(0x01)</td></tr>
<tr class="memdesc:ga748c37a9bbe04ddc680fe1686154fefb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push touch event occuring when your finger or pen coming to Nextion touch pannel. <br /></td></tr>
<tr class="separator:ga748c37a9bbe04ddc680fe1686154fefb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5db3d99f88ac878875ca47713b7a54b6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5db3d99f88ac878875ca47713b7a54b6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#ga5db3d99f88ac878875ca47713b7a54b6">NEX_EVENT_POP</a>&#160;&#160;&#160;(0x00)</td></tr>
<tr class="memdesc:ga5db3d99f88ac878875ca47713b7a54b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop touch event occuring when your finger or pen leaving from Nextion touch pannel. <br /></td></tr>
<tr class="separator:ga5db3d99f88ac878875ca47713b7a54b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga162dea47b078e8878d10d6981a9dd0c6"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#ga162dea47b078e8878d10d6981a9dd0c6">NexTouchEventCb</a> )(void *ptr)</td></tr>
<tr class="memdesc:ga162dea47b078e8878d10d6981a9dd0c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of callback funciton when an touch event occurs. <a href="#ga162dea47b078e8878d10d6981a9dd0c6">More...</a><br /></td></tr>
<tr class="separator:ga162dea47b078e8878d10d6981a9dd0c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab09ddba6b72334d30ae091a7b038d790"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#gab09ddba6b72334d30ae091a7b038d790">nexInit</a> (void)</td></tr>
<tr class="memdesc:gab09ddba6b72334d30ae091a7b038d790"><td class="mdescLeft">&#160;</td><td class="mdescRight">Init Nextion. <a href="#gab09ddba6b72334d30ae091a7b038d790">More...</a><br /></td></tr>
<tr class="separator:gab09ddba6b72334d30ae091a7b038d790"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91c549e696b0ca035cf18901e6a50d5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___nextion.html#ga91c549e696b0ca035cf18901e6a50d5a">nexLoop</a> (<a class="el" href="class_nex_touch.html">NexTouch</a> *nex_listen_list[])</td></tr>
<tr class="memdesc:ga91c549e696b0ca035cf18901e6a50d5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Listen touch event and calling callbacks attached before. <a href="#ga91c549e696b0ca035cf18901e6a50d5a">More...</a><br /></td></tr>
<tr class="separator:ga91c549e696b0ca035cf18901e6a50d5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga162dea47b078e8878d10d6981a9dd0c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* NexTouchEventCb)(void *ptr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of callback funciton when an touch event occurs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>- user pointer for any purpose. Commonly, it is a pointer to a object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl>
<p>Definition at line <a class="el" href="_nex_touch_8h_source.html#l00045">45</a> of file <a class="el" href="_nex_touch_8h_source.html">NexTouch.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab09ddba6b72334d30ae091a7b038d790"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool nexInit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Init Nextion. </p>
<dl class="section return"><dt>Returns</dt><dd>true if success, false for failure. </dd></dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00220">220</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ga91c549e696b0ca035cf18901e6a50d5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void nexLoop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_nex_touch.html">NexTouch</a> *&#160;</td>
<td class="paramname"><em>nex_listen_list</em>[]</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Listen touch event and calling callbacks attached before. </p>
<p>Supports push and pop at present.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nex_listen_list</td><td>- index to Nextion Components list. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This function must be called repeatedly to response touch events from Nextion touch panel. Actually, you should place it in your loop function. </dd></dl>
<p>Definition at line <a class="el" href="_nex_hardware_8cpp_source.html#l00235">235</a> of file <a class="el" href="_nex_hardware_8cpp_source.html">NexHardware.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 14 2015 17:02:22 for Nextion User Manual 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>
Reference in New Issue View Git Blame Copy Permalink