Files
ITEADLIB_Arduino_Nextion/doc/UserManual/class_nex_object.html
shennongmin 6d8006c43a Update comments.
Signed-off-by: shennongmin <wupangfee@gmail.com>
2015-08-14 14:02:04 +08:00

228 lines
12 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>Nextion User Manual: NexObject 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">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 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_object-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NexObject Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Root Class of Nextion Components.
<a href="class_nex_object.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_nex_object_8h_source.html">NexObject.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for NexObject:</div>
<div class="dyncontent">
<div class="center">
<img src="class_nex_object.png" usemap="#NexObject_map" alt=""/>
<map id="NexObject_map" name="NexObject_map">
<area href="class_nex_gauge.html" title="NexGauge,subclass of NexTouch,provides simple methods to control gauge component. ..." alt="NexGauge" shape="rect" coords="0,56,105,80"/>
<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,56,220,80"/>
<area href="class_nex_touch.html" title="Root Class of Nextion Components. " alt="NexTouch" shape="rect" coords="345,56,450,80"/>
<area href="class_nex_waveform.html" title="NexWaveform,subclass of NexTouch,provides simple methods to control NexWaveform component. " alt="NexWaveform" shape="rect" coords="460,56,565,80"/>
<area href="class_nex_button.html" title="NexButton,subclass of NexTouch,provides simple methods to control button component. " alt="NexButton" shape="rect" coords="0,112,105,136"/>
<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_hotspot.html" title="NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component. " alt="NexHotspot" shape="rect" coords="230,112,335,136"/>
<area href="class_nex_page.html" title="NexPage,subclass of NexTouch,provides simple methods to control page component. " alt="NexPage" shape="rect" coords="345,112,450,136"/>
<area href="class_nex_picture.html" title="NexPicture,subclass of NexTouch,provides simple methods to control picture component. " alt="NexPicture" shape="rect" coords="460,112,565,136"/>
<area href="class_nex_slider.html" title="NexSlider,subclass of NexTouch,provides simple methods to control slider component. " alt="NexSlider" shape="rect" coords="575,112,680,136"/>
<area href="class_nex_text.html" title="NexText,subclass of NexTouch,provides simple methods to control text component. " alt="NexText" shape="rect" coords="690,112,795,136"/>
</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:a47e8aee24a518936fbc27f00fda235c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#a47e8aee24a518936fbc27f00fda235c6">NexObject</a> (NexPid pid, NexCid cid, const char *name)</td></tr>
<tr class="memdesc:a47e8aee24a518936fbc27f00fda235c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a47e8aee24a518936fbc27f00fda235c6">More...</a><br /></td></tr>
<tr class="separator:a47e8aee24a518936fbc27f00fda235c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bf9f3059eb9475266edb4642078ade8"><td class="memItemLeft" align="right" valign="top">NexPid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#a2bf9f3059eb9475266edb4642078ade8">getObjPid</a> (void)</td></tr>
<tr class="memdesc:a2bf9f3059eb9475266edb4642078ade8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get page id. <a href="#a2bf9f3059eb9475266edb4642078ade8">More...</a><br /></td></tr>
<tr class="separator:a2bf9f3059eb9475266edb4642078ade8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cc1d0bd2acb58b46b6e156df169cd81"><td class="memItemLeft" align="right" valign="top">NexCid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#a0cc1d0bd2acb58b46b6e156df169cd81">getObjCid</a> (void)</td></tr>
<tr class="memdesc:a0cc1d0bd2acb58b46b6e156df169cd81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get component id. <a href="#a0cc1d0bd2acb58b46b6e156df169cd81">More...</a><br /></td></tr>
<tr class="separator:a0cc1d0bd2acb58b46b6e156df169cd81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea0246c02cd5e54d0dbd714ace1ff2b1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#aea0246c02cd5e54d0dbd714ace1ff2b1">getObjName</a> (void)</td></tr>
<tr class="memdesc:aea0246c02cd5e54d0dbd714ace1ff2b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get component name. <a href="#aea0246c02cd5e54d0dbd714ace1ff2b1">More...</a><br /></td></tr>
<tr class="separator:aea0246c02cd5e54d0dbd714ace1ff2b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeff0c61474e8b3ce6bac76771820b64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeff0c61474e8b3ce6bac76771820b64"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nex_object.html#abeff0c61474e8b3ce6bac76771820b64">printObjInfo</a> (void)</td></tr>
<tr class="memdesc:abeff0c61474e8b3ce6bac76771820b64"><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:abeff0c61474e8b3ce6bac76771820b64"><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>Root Class of Nextion Components. </p>
<p>Definition at line <a class="el" href="_nex_object_8h_source.html#l00027">27</a> of file <a class="el" href="_nex_object_8h_source.html">NexObject.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a47e8aee24a518936fbc27f00fda235c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NexObject::NexObject </td>
<td>(</td>
<td class="paramtype">NexPid&#160;</td>
<td class="paramname"><em>pid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">NexCid&#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>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>- component name. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_nex_object_8cpp_source.html#l00024">24</a> of file <a class="el" href="_nex_object_8cpp_source.html">NexObject.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0cc1d0bd2acb58b46b6e156df169cd81"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NexCid NexObject::getObjCid </td>
<td>(</td>
<td class="paramtype">void&#160;</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_object_8cpp_source.html#l00047">47</a> of file <a class="el" href="_nex_object_8cpp_source.html">NexObject.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aea0246c02cd5e54d0dbd714ace1ff2b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * NexObject::getObjName </td>
<td>(</td>
<td class="paramtype">void&#160;</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_object_8cpp_source.html#l00057">57</a> of file <a class="el" href="_nex_object_8cpp_source.html">NexObject.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2bf9f3059eb9475266edb4642078ade8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">NexPid NexObject::getObjPid </td>
<td>(</td>
<td class="paramtype">void&#160;</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_object_8cpp_source.html#l00037">37</a> of file <a class="el" href="_nex_object_8cpp_source.html">NexObject.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_nex_object_8h_source.html">NexObject.h</a></li>
<li><a class="el" href="_nex_object_8cpp_source.html">NexObject.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 14 2015 11:56:19 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>