iot-firmware/lib/ITEADLIB_Arduino_Nextion-master/latex/class_nex_variable.tex

\hypertarget{class_nex_variable}{\section{Nex\+Variable Class Reference}
\label{class_nex_variable}\index{Nex\+Variable@{Nex\+Variable}}
}


{\ttfamily \#include $<$Nex\+Variable.\+h$>$}

Inheritance diagram for Nex\+Variable\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{class_nex_variable}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_nex_variable_a7d36d19e14c991872fb1547f3ced09b2}{Nex\+Variable} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item 
uint32\+\_\+t \hyperlink{class_nex_variable_ab4d12f14dcff3f6930a2bdf5e1f3d259}{get\+Text} (char $\ast$buffer, uint32\+\_\+t len)
\item 
bool \hyperlink{class_nex_variable_aab59ac44eb0804664a03c09932be70eb}{set\+Text} (const char $\ast$buffer)
\item 
uint32\+\_\+t \hyperlink{class_nex_variable_aff06d16d022876c749d3e30f020b1557}{get\+Value} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_variable_a9da9d4a74f09e1787e4e4562da1e4833}{set\+Value} (uint32\+\_\+t number)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{class_nex_button}{Nex\+Button} component.

Commonly, you want to do something after push and pop it. It is recommanded that only call \hyperlink{class_nex_touch_a4da1c4fcdfadb7eabfb9ccaba9ecad11}{Nex\+Touch\+::attach\+Pop} to satisfy your purpose.

\begin{DoxyWarning}{Warning}
Please do not call \hyperlink{class_nex_touch_a685a753aae5eb9fb9866a7807a310132}{Nex\+Touch\+::attach\+Push} on this component, even though you can. 
\end{DoxyWarning}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_nex_variable_a7d36d19e14c991872fb1547f3ced09b2}{\index{Nex\+Variable@{Nex\+Variable}!Nex\+Variable@{Nex\+Variable}}
\index{Nex\+Variable@{Nex\+Variable}!Nex\+Variable@{Nex\+Variable}}
\subsubsection[{Nex\+Variable}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Variable\+::\+Nex\+Variable (
\begin{DoxyParamCaption}
\item[{uint8\+\_\+t}]{pid, }
\item[{uint8\+\_\+t}]{cid, }
\item[{const char $\ast$}]{name}
\end{DoxyParamCaption}
)}}\label{class_nex_variable_a7d36d19e14c991872fb1547f3ced09b2}




Constructor.


\begin{DoxyParams}{Parameters}
{\em pid} & -\/ page id. \\
\hline
{\em cid} & -\/ component id. \\
\hline
{\em name} & -\/ pointer to an unique name in range of all components. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{class_nex_variable_ab4d12f14dcff3f6930a2bdf5e1f3d259}{\index{Nex\+Variable@{Nex\+Variable}!get\+Text@{get\+Text}}
\index{get\+Text@{get\+Text}!Nex\+Variable@{Nex\+Variable}}
\subsubsection[{get\+Text}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Variable\+::get\+Text (
\begin{DoxyParamCaption}
\item[{char $\ast$}]{buffer, }
\item[{uint32\+\_\+t}]{len}
\end{DoxyParamCaption}
)}}\label{class_nex_variable_ab4d12f14dcff3f6930a2bdf5e1f3d259}
Get text attribute of component.


\begin{DoxyParams}{Parameters}
{\em buffer} & -\/ buffer storing text returned. \\
\hline
{\em len} & -\/ length of buffer. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The real length of text returned. 
\end{DoxyReturn}
\hypertarget{class_nex_variable_aff06d16d022876c749d3e30f020b1557}{\index{Nex\+Variable@{Nex\+Variable}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Nex\+Variable@{Nex\+Variable}}
\subsubsection[{get\+Value}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Variable\+::get\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_variable_aff06d16d022876c749d3e30f020b1557}
Get val attribute of component


\begin{DoxyParams}{Parameters}
{\em number} & -\/ buffer storing data retur \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the length of the data 
\end{DoxyReturn}
\hypertarget{class_nex_variable_aab59ac44eb0804664a03c09932be70eb}{\index{Nex\+Variable@{Nex\+Variable}!set\+Text@{set\+Text}}
\index{set\+Text@{set\+Text}!Nex\+Variable@{Nex\+Variable}}
\subsubsection[{set\+Text}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Variable\+::set\+Text (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{buffer}
\end{DoxyParamCaption}
)}}\label{class_nex_variable_aab59ac44eb0804664a03c09932be70eb}
Set text attribute of component.


\begin{DoxyParams}{Parameters}
{\em buffer} & -\/ text buffer terminated with '\textbackslash{}0'. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if success, false for failure. 
\end{DoxyReturn}
\hypertarget{class_nex_variable_a9da9d4a74f09e1787e4e4562da1e4833}{\index{Nex\+Variable@{Nex\+Variable}!set\+Value@{set\+Value}}
\index{set\+Value@{set\+Value}!Nex\+Variable@{Nex\+Variable}}
\subsubsection[{set\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Variable\+::set\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_variable_a9da9d4a74f09e1787e4e4562da1e4833}
Set val attribute of component


\begin{DoxyParams}{Parameters}
{\em number} & -\/ To set up the data \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if success, false for failure 
\end{DoxyReturn}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Nex\+Variable.\+h\item 
\hyperlink{_nex_variable_8cpp}{Nex\+Variable.\+cpp}\end{DoxyCompactItemize}