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

\hypertarget{class_nex_gauge}{\section{Nex\+Gauge Class Reference}
\label{class_nex_gauge}\index{Nex\+Gauge@{Nex\+Gauge}}
}


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

Inheritance diagram for Nex\+Gauge\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_nex_gauge}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_nex_gauge_ac79040067d42f7f1ba16cc4a1dfd8b9b}{Nex\+Gauge} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item 
bool \hyperlink{class_nex_gauge_aeea8933513ebba11584ad97f8c8b5e69}{get\+Value} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_gauge_a448ce9ad69f54c156c325d578a96b765}{set\+Value} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_gauge_a03a6441159939961b64728dded177e92}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_gauge_a2d2fe2d81da81e14a66260c501d644b3}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_gauge_a830152d58485d55f475376261d52ff62}{Get\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_gauge_ace00cba20b5cf5e1374c1a57bbf9a5f5}{Set\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_gauge_a50b4daf1b8dfb3cc5c329a3664341e11}{Get\+\_\+pointer\+\_\+thickness\+\_\+wid} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_gauge_adacdbcb25fdf45654ebc88f572e3bce9}{Set\+\_\+pointer\+\_\+thickness\+\_\+wid} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_gauge_a0a6b394a16b03beb6046ec3795d409fe}{Get\+\_\+background\+\_\+cropi\+\_\+picc} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_gauge_a223fa8a91a87439047f22ca1c33660df}{Set\+\_\+background\+\_\+crop\+\_\+picc} (uint32\+\_\+t number)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{class_nex_gauge}{Nex\+Gauge} component. 

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




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_gauge_a03a6441159939961b64728dded177e92}{\index{Nex\+Gauge@{Nex\+Gauge}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Gauge\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a03a6441159939961b64728dded177e92}
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_gauge_a0a6b394a16b03beb6046ec3795d409fe}{\index{Nex\+Gauge@{Nex\+Gauge}!Get\+\_\+background\+\_\+cropi\+\_\+picc@{Get\+\_\+background\+\_\+cropi\+\_\+picc}}
\index{Get\+\_\+background\+\_\+cropi\+\_\+picc@{Get\+\_\+background\+\_\+cropi\+\_\+picc}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Get\+\_\+background\+\_\+cropi\+\_\+picc}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Gauge\+::\+Get\+\_\+background\+\_\+cropi\+\_\+picc (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a0a6b394a16b03beb6046ec3795d409fe}
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_gauge_a830152d58485d55f475376261d52ff62}{\index{Nex\+Gauge@{Nex\+Gauge}!Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}}
\index{Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Get\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Gauge\+::\+Get\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a830152d58485d55f475376261d52ff62}
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_gauge_a50b4daf1b8dfb3cc5c329a3664341e11}{\index{Nex\+Gauge@{Nex\+Gauge}!Get\+\_\+pointer\+\_\+thickness\+\_\+wid@{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}}
\index{Get\+\_\+pointer\+\_\+thickness\+\_\+wid@{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Gauge\+::\+Get\+\_\+pointer\+\_\+thickness\+\_\+wid (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a50b4daf1b8dfb3cc5c329a3664341e11}
Get wid 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_gauge_aeea8933513ebba11584ad97f8c8b5e69}{\index{Nex\+Gauge@{Nex\+Gauge}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{get\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::get\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_aeea8933513ebba11584ad97f8c8b5e69}
Get the value of gauge.


\begin{DoxyParams}{Parameters}
{\em number} & -\/ an output parameter to save gauge's value.\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}
\hypertarget{class_nex_gauge_a2d2fe2d81da81e14a66260c501d644b3}{\index{Nex\+Gauge@{Nex\+Gauge}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a2d2fe2d81da81e14a66260c501d644b3}
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_gauge_a223fa8a91a87439047f22ca1c33660df}{\index{Nex\+Gauge@{Nex\+Gauge}!Set\+\_\+background\+\_\+crop\+\_\+picc@{Set\+\_\+background\+\_\+crop\+\_\+picc}}
\index{Set\+\_\+background\+\_\+crop\+\_\+picc@{Set\+\_\+background\+\_\+crop\+\_\+picc}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Set\+\_\+background\+\_\+crop\+\_\+picc}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::\+Set\+\_\+background\+\_\+crop\+\_\+picc (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a223fa8a91a87439047f22ca1c33660df}
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_gauge_ace00cba20b5cf5e1374c1a57bbf9a5f5}{\index{Nex\+Gauge@{Nex\+Gauge}!Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}}
\index{Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Set\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::\+Set\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_ace00cba20b5cf5e1374c1a57bbf9a5f5}
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_gauge_adacdbcb25fdf45654ebc88f572e3bce9}{\index{Nex\+Gauge@{Nex\+Gauge}!Set\+\_\+pointer\+\_\+thickness\+\_\+wid@{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}}
\index{Set\+\_\+pointer\+\_\+thickness\+\_\+wid@{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::\+Set\+\_\+pointer\+\_\+thickness\+\_\+wid (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_adacdbcb25fdf45654ebc88f572e3bce9}
Set wid 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_gauge_a448ce9ad69f54c156c325d578a96b765}{\index{Nex\+Gauge@{Nex\+Gauge}!set\+Value@{set\+Value}}
\index{set\+Value@{set\+Value}!Nex\+Gauge@{Nex\+Gauge}}
\subsubsection[{set\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Gauge\+::set\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_gauge_a448ce9ad69f54c156c325d578a96b765}
Set the value of gauge.


\begin{DoxyParams}{Parameters}
{\em number} & -\/ the value of gauge.\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}


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