mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-03 16:54:00 +01:00
181 lines
7.4 KiB
TeX
Executable File
181 lines
7.4 KiB
TeX
Executable File
\hypertarget{class_nex_progress_bar}{\section{Nex\+Progress\+Bar Class Reference}
|
|
\label{class_nex_progress_bar}\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
}
|
|
|
|
|
|
{\ttfamily \#include $<$Nex\+Progress\+Bar.\+h$>$}
|
|
|
|
Inheritance diagram for Nex\+Progress\+Bar\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.000000cm]{class_nex_progress_bar}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\hyperlink{class_nex_progress_bar_a61f76f0c855c7839630dbc930e3401d8}{Nex\+Progress\+Bar} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
|
|
\item
|
|
bool \hyperlink{class_nex_progress_bar_a3e5eb13b2aa014c8f6a9e16439917bf2}{get\+Value} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_progress_bar_aaa7937d364cb63151bd1e1bc4729334d}{set\+Value} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_progress_bar_a2efc0d6694d8739fb9caa31c53190271}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_progress_bar_ab0b4230a6559989080e2a7b66b42ffc1}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_progress_bar_aa148721b86c5f56c6321780da3ef974f}{Get\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_progress_bar_a0ee8478a28a3c31d4b7179317299f711}{Set\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t number)
|
|
\end{DoxyCompactItemize}
|
|
\subsection*{Additional Inherited Members}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\hyperlink{class_nex_progress_bar}{Nex\+Progress\+Bar} component.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\hypertarget{class_nex_progress_bar_a61f76f0c855c7839630dbc930e3401d8}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{Nex\+Progress\+Bar}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Progress\+Bar\+::\+Nex\+Progress\+Bar (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint8\+\_\+t}]{pid, }
|
|
\item[{uint8\+\_\+t}]{cid, }
|
|
\item[{const char $\ast$}]{name}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_a61f76f0c855c7839630dbc930e3401d8}
|
|
|
|
|
|
|
|
|
|
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_progress_bar_a2efc0d6694d8739fb9caa31c53190271}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
|
|
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Progress\+Bar\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_a2efc0d6694d8739fb9caa31c53190271}
|
|
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_progress_bar_aa148721b86c5f56c6321780da3ef974f}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}}
|
|
\index{Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{Get\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Progress\+Bar\+::\+Get\+\_\+font\+\_\+color\+\_\+pco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_aa148721b86c5f56c6321780da3ef974f}
|
|
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_progress_bar_a3e5eb13b2aa014c8f6a9e16439917bf2}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!get\+Value@{get\+Value}}
|
|
\index{get\+Value@{get\+Value}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{get\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Progress\+Bar\+::get\+Value (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_a3e5eb13b2aa014c8f6a9e16439917bf2}
|
|
Get the value of progress bar.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em number} & -\/ an output parameter to save the value of porgress bar.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyRetVals}{Return values}
|
|
{\em true} & -\/ success. \\
|
|
\hline
|
|
{\em false} & -\/ failed. \\
|
|
\hline
|
|
\end{DoxyRetVals}
|
|
\hypertarget{class_nex_progress_bar_ab0b4230a6559989080e2a7b66b42ffc1}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
|
|
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Progress\+Bar\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_ab0b4230a6559989080e2a7b66b42ffc1}
|
|
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_progress_bar_a0ee8478a28a3c31d4b7179317299f711}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}}
|
|
\index{Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{Set\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Progress\+Bar\+::\+Set\+\_\+font\+\_\+color\+\_\+pco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_a0ee8478a28a3c31d4b7179317299f711}
|
|
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_progress_bar_aaa7937d364cb63151bd1e1bc4729334d}{\index{Nex\+Progress\+Bar@{Nex\+Progress\+Bar}!set\+Value@{set\+Value}}
|
|
\index{set\+Value@{set\+Value}!Nex\+Progress\+Bar@{Nex\+Progress\+Bar}}
|
|
\subsubsection[{set\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Progress\+Bar\+::set\+Value (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_progress_bar_aaa7937d364cb63151bd1e1bc4729334d}
|
|
Set the value of progress bar.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em number} & -\/ the value of progress bar.\\
|
|
\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_progress_bar_8h}{Nex\+Progress\+Bar.\+h}\item
|
|
\hyperlink{_nex_progress_bar_8cpp}{Nex\+Progress\+Bar.\+cpp}\end{DoxyCompactItemize}
|