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

\hypertarget{class_nex_checkbox}{\section{Nex\+Checkbox Class Reference}
\label{class_nex_checkbox}\index{Nex\+Checkbox@{Nex\+Checkbox}}
}


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

Inheritance diagram for Nex\+Checkbox\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{class_nex_checkbox}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_nex_checkbox_a8aa4ea60796bdce0de0de3dd675ef56a}{Nex\+Checkbox} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item 
uint32\+\_\+t \hyperlink{class_nex_checkbox_a6832110a49f9bbbb14a54f36db020d44}{get\+Value} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_checkbox_aa932e7c45765400618dce1804766264b}{set\+Value} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_checkbox_abca30f46ecb7a4c88d816af85fa7f777}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_checkbox_ab430ba5908c84fea8ab910002581350a}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
\item 
uint32\+\_\+t \hyperlink{class_nex_checkbox_a93fbcf8796f156e6700ebf3e13abfce6}{Get\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_checkbox_aa1d52cc0170f11ec85263770fe77db2a}{Set\+\_\+font\+\_\+color\+\_\+pco} (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_checkbox_a8aa4ea60796bdce0de0de3dd675ef56a}{\index{Nex\+Checkbox@{Nex\+Checkbox}!Nex\+Checkbox@{Nex\+Checkbox}}
\index{Nex\+Checkbox@{Nex\+Checkbox}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{Nex\+Checkbox}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Checkbox\+::\+Nex\+Checkbox (
\begin{DoxyParamCaption}
\item[{uint8\+\_\+t}]{pid, }
\item[{uint8\+\_\+t}]{cid, }
\item[{const char $\ast$}]{name}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_a8aa4ea60796bdce0de0de3dd675ef56a}




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_checkbox_abca30f46ecb7a4c88d816af85fa7f777}{\index{Nex\+Checkbox@{Nex\+Checkbox}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Checkbox\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_abca30f46ecb7a4c88d816af85fa7f777}
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_checkbox_a93fbcf8796f156e6700ebf3e13abfce6}{\index{Nex\+Checkbox@{Nex\+Checkbox}!Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}}
\index{Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{Get\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Checkbox\+::\+Get\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_a93fbcf8796f156e6700ebf3e13abfce6}
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_checkbox_a6832110a49f9bbbb14a54f36db020d44}{\index{Nex\+Checkbox@{Nex\+Checkbox}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{get\+Value}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Checkbox\+::get\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_a6832110a49f9bbbb14a54f36db020d44}
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_checkbox_ab430ba5908c84fea8ab910002581350a}{\index{Nex\+Checkbox@{Nex\+Checkbox}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Checkbox\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_ab430ba5908c84fea8ab910002581350a}
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_checkbox_aa1d52cc0170f11ec85263770fe77db2a}{\index{Nex\+Checkbox@{Nex\+Checkbox}!Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}}
\index{Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{Set\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Checkbox\+::\+Set\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_aa1d52cc0170f11ec85263770fe77db2a}
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_checkbox_aa932e7c45765400618dce1804766264b}{\index{Nex\+Checkbox@{Nex\+Checkbox}!set\+Value@{set\+Value}}
\index{set\+Value@{set\+Value}!Nex\+Checkbox@{Nex\+Checkbox}}
\subsubsection[{set\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Checkbox\+::set\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_checkbox_aa932e7c45765400618dce1804766264b}
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 
\hyperlink{_nex_checkbox_8h}{Nex\+Checkbox.\+h}\item 
\hyperlink{_nex_checkbox_8cpp}{Nex\+Checkbox.\+cpp}\end{DoxyCompactItemize}