ise-senior-iot
/
iot-firmware
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
iot-firmware/lib/ITEADLIB_Arduino_Nextion-ma.../html/class_nex_touch.html

326 lines
18 KiB
HTML
Raw Normal View History

nextion
2023-09-30 08:42:44 +00:00
<!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>My Project: 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="class_nex_touch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NexTouch Class Reference<div class="ingroups"><a class="el" href="group___touch_event.html">Touch Event</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_nex_touch_8h_source.html">NexTouch.h</a>&gt;</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_object.html" alt="NexObject" shape="rect" coords="0,0,90,24"/>
<area href="class_nex_button.html" alt="NexButton" shape="rect" coords="100,112,190,136"/>
<area href="class_nex_checkbox.html" alt="NexCheckbox" shape="rect" coords="100,168,190,192"/>
<area href="class_nex_crop.html" alt="NexCrop" shape="rect" coords="100,224,190,248"/>
<area href="class_nex_d_s_button.html" alt="NexDSButton" shape="rect" coords="100,280,190,304"/>
<area href="class_nex_hotspot.html" alt="NexHotspot" shape="rect" coords="100,336,190,360"/>
<area href="class_nex_number.html" alt="NexNumber" shape="rect" coords="100,392,190,416"/>
<area href="class_nex_page.html" alt="NexPage" shape="rect" coords="100,448,190,472"/>
<area href="class_nex_picture.html" alt="NexPicture" shape="rect" coords="100,504,190,528"/>
<area href="class_nex_radio.html" alt="NexRadio" shape="rect" coords="100,560,190,584"/>
<area href="class_nex_scrolltext.html" alt="NexScrolltext" shape="rect" coords="100,616,190,640"/>
<area href="class_nex_slider.html" alt="NexSlider" shape="rect" coords="100,672,190,696"/>
<area href="class_nex_text.html" alt="NexText" shape="rect" coords="100,728,190,752"/>
<area href="class_nex_timer.html" alt="NexTimer" shape="rect" coords="100,784,190,808"/>
<area href="class_nex_variable.html" alt="NexVariable" shape="rect" coords="100,840,190,864"/>
</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:a9e028e45e0d2d2cc39c8bf8d03dbb887"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a9e028e45e0d2d2cc39c8bf8d03dbb887">NexTouch</a> (uint8_t pid, uint8_t cid, const char *name)</td></tr>
<tr class="separator:a9e028e45e0d2d2cc39c8bf8d03dbb887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685a753aae5eb9fb9866a7807a310132"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a685a753aae5eb9fb9866a7807a310132">attachPush</a> (<a class="el" href="group___touch_event.html#ga162dea47b078e8878d10d6981a9dd0c6">NexTouchEventCb</a> push, void *ptr=NULL)</td></tr>
<tr class="separator:a685a753aae5eb9fb9866a7807a310132"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc36096119534344c2bcd8021b93289"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a2bc36096119534344c2bcd8021b93289">detachPush</a> (void)</td></tr>
<tr class="separator:a2bc36096119534344c2bcd8021b93289"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4da1c4fcdfadb7eabfb9ccaba9ecad11"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#a4da1c4fcdfadb7eabfb9ccaba9ecad11">attachPop</a> (<a class="el" href="group___touch_event.html#ga162dea47b078e8878d10d6981a9dd0c6">NexTouchEventCb</a> pop, void *ptr=NULL)</td></tr>
<tr class="separator:a4da1c4fcdfadb7eabfb9ccaba9ecad11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af656640c1078a553287a68bf792dd291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_touch.html#af656640c1078a553287a68bf792dd291">detachPop</a> (void)</td></tr>
<tr class="separator:af656640c1078a553287a68bf792dd291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_nex_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_nex_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_nex_object.html">NexObject</a></td></tr>
<tr class="memitem:ab15aadb9c91d9690786d8d25d12d94e1 inherit pub_methods_class_nex_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#ab15aadb9c91d9690786d8d25d12d94e1">NexObject</a> (uint8_t pid, uint8_t cid, const char *name)</td></tr>
<tr class="separator:ab15aadb9c91d9690786d8d25d12d94e1 inherit pub_methods_class_nex_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeff0c61474e8b3ce6bac76771820b64 inherit pub_methods_class_nex_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#abeff0c61474e8b3ce6bac76771820b64">printObjInfo</a> (void)</td></tr>
<tr class="separator:abeff0c61474e8b3ce6bac76771820b64 inherit pub_methods_class_nex_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa17cd9f742159ab61b60362b8d752b6f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa17cd9f742159ab61b60362b8d752b6f"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>iterate</b> (<a class="el" href="class_nex_touch.html">NexTouch</a> **list, uint8_t pid, uint8_t cid, int32_t event)</td></tr>
<tr class="separator:aa17cd9f742159ab61b60362b8d752b6f"><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 pro_methods_class_nex_object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_nex_object')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_nex_object.html">NexObject</a></td></tr>
<tr class="memitem:a67621e5d7bcfb50c1a1bbc4ad1020352 inherit pro_methods_class_nex_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67621e5d7bcfb50c1a1bbc4ad1020352"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>getObjPid</b> (void)</td></tr>
<tr class="separator:a67621e5d7bcfb50c1a1bbc4ad1020352 inherit pro_methods_class_nex_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8139b294806c1684fc95b635a33b1b15 inherit pro_methods_class_nex_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8139b294806c1684fc95b635a33b1b15"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>getObjCid</b> (void)</td></tr>
<tr class="separator:a8139b294806c1684fc95b635a33b1b15 inherit pro_methods_class_nex_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0246c02cd5e54d0dbd714ace1ff2b1 inherit pro_methods_class_nex_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea0246c02cd5e54d0dbd714ace1ff2b1"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>getObjName</b> (void)</td></tr>
<tr class="separator:aea0246c02cd5e54d0dbd714ace1ff2b1 inherit pro_methods_class_nex_object"><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>Father class of the components with touch events.</p>
<p>Derives from <a class="el" href="class_nex_object.html">NexObject</a> and provides methods allowing user to attach (or detach) a callback function called when push(or pop) touch event occurs. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9e028e45e0d2d2cc39c8bf8d03dbb887"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NexTouch::NexTouch </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>cid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<p>Constructor.</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>- pointer to an unique name in range of all components. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4da1c4fcdfadb7eabfb9ccaba9ecad11"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NexTouch::attachPop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___touch_event.html#ga162dea47b078e8878d10d6981a9dd0c6">NexTouchEventCb</a>&#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>Attach an callback function of pop touch event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pop</td><td>- callback called with ptr when a pop touch event occurs. </td></tr>
<tr><td class="paramname">ptr</td><td>- parameter passed into pop[default:NULL]. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>If calling this method multiply, the last call is valid. </dd></dl>
</div>
</div>
<a class="anchor" id="a685a753aae5eb9fb9866a7807a310132"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NexTouch::attachPush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___touch_event.html#ga162dea47b078e8878d10d6981a9dd0c6">NexTouchEventCb</a>&#160;</td>
<td class="paramname"><em>push</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>Attach an callback function of push touch event.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">push</td><td>- callback called with ptr when a push touch event occurs. </td></tr>
<tr><td class="paramname">ptr</td><td>- parameter passed into push[default:NULL]. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>If calling this method multiply, the last call is valid. </dd></dl>
</div>
</div>
<a class="anchor" id="af656640c1078a553287a68bf792dd291"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NexTouch::detachPop </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach an callback function.</p>
<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl>
</div>
</div>
<a class="anchor" id="a2bc36096119534344c2bcd8021b93289"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NexTouch::detachPush </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detach an callback function.</p>
<dl class="section return"><dt>Returns</dt><dd>none. </dd></dl>
</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.html">NexTouch.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Dec 1 2016 09:26:04 for My Project 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>