mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-04 09:14:01 +01:00
177 lines
8.9 KiB
HTML
177 lines
8.9 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 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_object-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">NexObject Class Reference<div class="ingroups"><a class="el" href="group___core_a_p_i.html">Core API</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Root class of all Nextion components.
|
|
<a href="class_nex_object.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_nex_object_8h_source.html">NexObject.h</a>></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 component. " alt="NexGauge" shape="rect" coords="0,56,105,80"/>
|
|
<area href="class_nex_progress_bar.html" title="NexProgressBar component. " alt="NexProgressBar" shape="rect" coords="115,56,220,80"/>
|
|
<area href="class_nex_touch.html" title="Father class of the components with touch events. " alt="NexTouch" shape="rect" coords="345,56,450,80"/>
|
|
<area href="class_nex_waveform.html" title="NexWaveform component. " alt="NexWaveform" shape="rect" coords="460,56,565,80"/>
|
|
<area href="class_nex_button.html" title="NexButton component. " alt="NexButton" shape="rect" coords="0,112,105,136"/>
|
|
<area href="class_nex_crop.html" title="NexCrop component. " alt="NexCrop" shape="rect" coords="115,112,220,136"/>
|
|
<area href="class_nex_hotspot.html" title="NexHotspot component. " alt="NexHotspot" shape="rect" coords="230,112,335,136"/>
|
|
<area href="class_nex_page.html" title="A special component , which can contain other components such as NexButton, NexText and NexWaveform..." alt="NexPage" shape="rect" coords="345,112,450,136"/>
|
|
<area href="class_nex_picture.html" title="NexPicture component. " alt="NexPicture" shape="rect" coords="460,112,565,136"/>
|
|
<area href="class_nex_slider.html" title="NexSlider component. " alt="NexSlider" shape="rect" coords="575,112,680,136"/>
|
|
<area href="class_nex_text.html" title="NexText 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:ab15aadb9c91d9690786d8d25d12d94e1"><td class="memItemLeft" align="right" valign="top"> </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="memdesc:ab15aadb9c91d9690786d8d25d12d94e1"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ab15aadb9c91d9690786d8d25d12d94e1">More...</a><br /></td></tr>
|
|
<tr class="separator:ab15aadb9c91d9690786d8d25d12d94e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abeff0c61474e8b3ce6bac76771820b64"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Print current object'address, page id, component id and name. <a href="#abeff0c61474e8b3ce6bac76771820b64">More...</a><br /></td></tr>
|
|
<tr class="separator:abeff0c61474e8b3ce6bac76771820b64"><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 all Nextion components. </p>
|
|
<p>Provides the essential attributes of a Nextion component and the methods accessing them. At least, Page ID(pid), Component ID(pid) and an unique name are needed for creating a component in Nexiton library. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_object_8h_source.html#l00032">32</a> of file <a class="el" href="_nex_object_8h_source.html">NexObject.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ab15aadb9c91d9690786d8d25d12d94e1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">NexObject::NexObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>pid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em> </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>- pointer to an unique name in range of all components. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_object_8cpp_source.html#l00017">17</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="abeff0c61474e8b3ce6bac76771820b64"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void NexObject::printObjInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Print current object'address, page id, component id and name. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>this method does nothing, unless debug message enabled. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_nex_object_8cpp_source.html#l00039">39</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 18:24:34 for Nextion User Manual 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>
|