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

\hypertarget{class_nex_text}{\section{Nex\+Text Class Reference}
\label{class_nex_text}\index{Nex\+Text@{Nex\+Text}}
}


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

Inheritance diagram for Nex\+Text\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{class_nex_text}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_nex_text_a38b4dd752d39bfda4ef7642b43ded91a}{Nex\+Text} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item 
uint16\+\_\+t \hyperlink{class_nex_text_a9cf417b2f25df2872492c55bdc9f5b30}{get\+Text} (char $\ast$buffer, uint16\+\_\+t len)
\item 
bool \hyperlink{class_nex_text_a19589b32c981436a1bbcfe407bc766e3}{set\+Text} (const char $\ast$buffer)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_aec8d21665688ba80f3136a1f5e23fef5}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_a1b1586e5e66d76a4f8f5c40b0986f471}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_a860af363c6de6180ef356cad31936185}{Get\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_ab59df7e777198eefb422ba2081d0cfce}{Set\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_a510a937a104b41859badc220a8ba39fb}{Get\+\_\+place\+\_\+xcen} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_ab94a4b8505a9bfdf8fb4cb8cb32a1763}{Set\+\_\+place\+\_\+xcen} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_a9bd42732e37497a8fb44ece94b39285c}{Get\+\_\+place\+\_\+ycen} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_a0f8ad9780c8145569da6736d0ee494e4}{Set\+\_\+place\+\_\+ycen} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_adc480199a2b396811aa0c14928b592c8}{get\+Font} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_a5dd7fdda945a76033ef8fe8dc68e3e52}{set\+Font} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_ae44393fb20ba449bf088dbd0758b4219}{Get\+\_\+background\+\_\+crop\+\_\+picc} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_a3727463a4fc0e1df978cd8fc7d1103ed}{Set\+\_\+background\+\_\+crop\+\_\+picc} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_text_aed07b3988fe2c4ec332727bb245e49a5}{Get\+\_\+background\+\_\+image\+\_\+pic} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_text_ab2c85ac7d5184e124b0cd724028c1915}{Set\+\_\+background\+\_\+image\+\_\+pic} (uint32\+\_\+t number)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{class_nex_text}{Nex\+Text} component. 

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




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_text_aec8d21665688ba80f3136a1f5e23fef5}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_aec8d21665688ba80f3136a1f5e23fef5}
Get bco 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_text_ae44393fb20ba449bf088dbd0758b4219}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+background\+\_\+crop\+\_\+picc@{Get\+\_\+background\+\_\+crop\+\_\+picc}}
\index{Get\+\_\+background\+\_\+crop\+\_\+picc@{Get\+\_\+background\+\_\+crop\+\_\+picc}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+background\+\_\+crop\+\_\+picc}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+background\+\_\+crop\+\_\+picc (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_ae44393fb20ba449bf088dbd0758b4219}
Get picc 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_text_aed07b3988fe2c4ec332727bb245e49a5}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+background\+\_\+image\+\_\+pic@{Get\+\_\+background\+\_\+image\+\_\+pic}}
\index{Get\+\_\+background\+\_\+image\+\_\+pic@{Get\+\_\+background\+\_\+image\+\_\+pic}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+background\+\_\+image\+\_\+pic}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+background\+\_\+image\+\_\+pic (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_aed07b3988fe2c4ec332727bb245e49a5}
Get pic 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_text_a860af363c6de6180ef356cad31936185}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}}
\index{Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a860af363c6de6180ef356cad31936185}
Get pco 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_text_a510a937a104b41859badc220a8ba39fb}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+place\+\_\+xcen@{Get\+\_\+place\+\_\+xcen}}
\index{Get\+\_\+place\+\_\+xcen@{Get\+\_\+place\+\_\+xcen}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+place\+\_\+xcen}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+place\+\_\+xcen (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a510a937a104b41859badc220a8ba39fb}
Get xcen 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_text_a9bd42732e37497a8fb44ece94b39285c}{\index{Nex\+Text@{Nex\+Text}!Get\+\_\+place\+\_\+ycen@{Get\+\_\+place\+\_\+ycen}}
\index{Get\+\_\+place\+\_\+ycen@{Get\+\_\+place\+\_\+ycen}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Get\+\_\+place\+\_\+ycen}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::\+Get\+\_\+place\+\_\+ycen (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a9bd42732e37497a8fb44ece94b39285c}
Get ycen 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_text_adc480199a2b396811aa0c14928b592c8}{\index{Nex\+Text@{Nex\+Text}!get\+Font@{get\+Font}}
\index{get\+Font@{get\+Font}!Nex\+Text@{Nex\+Text}}
\subsubsection[{get\+Font}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Text\+::get\+Font (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_adc480199a2b396811aa0c14928b592c8}
Get font 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_text_a9cf417b2f25df2872492c55bdc9f5b30}{\index{Nex\+Text@{Nex\+Text}!get\+Text@{get\+Text}}
\index{get\+Text@{get\+Text}!Nex\+Text@{Nex\+Text}}
\subsubsection[{get\+Text}]{\setlength{\rightskip}{0pt plus 5cm}uint16\+\_\+t Nex\+Text\+::get\+Text (
\begin{DoxyParamCaption}
\item[{char $\ast$}]{buffer, }
\item[{uint16\+\_\+t}]{len}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a9cf417b2f25df2872492c55bdc9f5b30}
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_text_a1b1586e5e66d76a4f8f5c40b0986f471}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a1b1586e5e66d76a4f8f5c40b0986f471}
Set bco 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}
\hypertarget{class_nex_text_a3727463a4fc0e1df978cd8fc7d1103ed}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+background\+\_\+crop\+\_\+picc@{Set\+\_\+background\+\_\+crop\+\_\+picc}}
\index{Set\+\_\+background\+\_\+crop\+\_\+picc@{Set\+\_\+background\+\_\+crop\+\_\+picc}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+background\+\_\+crop\+\_\+picc}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+background\+\_\+crop\+\_\+picc (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a3727463a4fc0e1df978cd8fc7d1103ed}
Set picc 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}
\hypertarget{class_nex_text_ab2c85ac7d5184e124b0cd724028c1915}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+background\+\_\+image\+\_\+pic@{Set\+\_\+background\+\_\+image\+\_\+pic}}
\index{Set\+\_\+background\+\_\+image\+\_\+pic@{Set\+\_\+background\+\_\+image\+\_\+pic}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+background\+\_\+image\+\_\+pic}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+background\+\_\+image\+\_\+pic (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_ab2c85ac7d5184e124b0cd724028c1915}
Set pic 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}
\hypertarget{class_nex_text_ab59df7e777198eefb422ba2081d0cfce}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}}
\index{Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_ab59df7e777198eefb422ba2081d0cfce}
Set pco 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}
\hypertarget{class_nex_text_ab94a4b8505a9bfdf8fb4cb8cb32a1763}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+place\+\_\+xcen@{Set\+\_\+place\+\_\+xcen}}
\index{Set\+\_\+place\+\_\+xcen@{Set\+\_\+place\+\_\+xcen}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+place\+\_\+xcen}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+place\+\_\+xcen (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_ab94a4b8505a9bfdf8fb4cb8cb32a1763}
Set xcen 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}
\hypertarget{class_nex_text_a0f8ad9780c8145569da6736d0ee494e4}{\index{Nex\+Text@{Nex\+Text}!Set\+\_\+place\+\_\+ycen@{Set\+\_\+place\+\_\+ycen}}
\index{Set\+\_\+place\+\_\+ycen@{Set\+\_\+place\+\_\+ycen}!Nex\+Text@{Nex\+Text}}
\subsubsection[{Set\+\_\+place\+\_\+ycen}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::\+Set\+\_\+place\+\_\+ycen (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a0f8ad9780c8145569da6736d0ee494e4}
Set ycen 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}
\hypertarget{class_nex_text_a5dd7fdda945a76033ef8fe8dc68e3e52}{\index{Nex\+Text@{Nex\+Text}!set\+Font@{set\+Font}}
\index{set\+Font@{set\+Font}!Nex\+Text@{Nex\+Text}}
\subsubsection[{set\+Font}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::set\+Font (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a5dd7fdda945a76033ef8fe8dc68e3e52}
Set font 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}
\hypertarget{class_nex_text_a19589b32c981436a1bbcfe407bc766e3}{\index{Nex\+Text@{Nex\+Text}!set\+Text@{set\+Text}}
\index{set\+Text@{set\+Text}!Nex\+Text@{Nex\+Text}}
\subsubsection[{set\+Text}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Text\+::set\+Text (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{buffer}
\end{DoxyParamCaption}
)}}\label{class_nex_text_a19589b32c981436a1bbcfe407bc766e3}
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}


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