iot-firmware/lib/ITEADLIB_Arduino_Nextion-ma.../latex/class_nex_slider.tex

333 lines
14 KiB
TeX
Raw Normal View History

2023-09-30 08:42:44 +00:00
\hypertarget{class_nex_slider}{\section{Nex\+Slider Class Reference}
\label{class_nex_slider}\index{Nex\+Slider@{Nex\+Slider}}
}
{\ttfamily \#include $<$Nex\+Slider.\+h$>$}
Inheritance diagram for Nex\+Slider\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{class_nex_slider}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{class_nex_slider_a00c5678209c936e9a57c14b6e2384774}{Nex\+Slider} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item
bool \hyperlink{class_nex_slider_a384d5488b421efd6affbfd32f45bb107}{get\+Value} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_a3f325bda4db913e302e94a4b25de7b5f}{set\+Value} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_a1cf49184702852c0623a695f4b62b1ed}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_ac22c66fecb8cf03d554c3c86e6e798d5}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_aa6361627b3c66ee7a569b5cfec4ce562}{Get\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_acc766d430c7a663846e4da6e1bacf76c}{Set\+\_\+font\+\_\+color\+\_\+pco} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_a6adbc43b663e3542a92641c406db23ad}{Get\+\_\+pointer\+\_\+thickness\+\_\+wid} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_a6b91c1f7fddf7ea1b62c406453110ead}{Set\+\_\+pointer\+\_\+thickness\+\_\+wid} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_a680c31b1aa2dc48a1193c9d8fb3cd487}{Get\+\_\+cursor\+\_\+height\+\_\+hig} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_a603cf3685c6d843261d8552030af9f22}{Set\+\_\+cursor\+\_\+height\+\_\+hig} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_abf1b50605feb0ac2b381d1148795f0d9}{get\+Maxval} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_a5a1c65a9f2e21a624b78d5817d695503}{set\+Maxval} (uint32\+\_\+t number)
\item
uint32\+\_\+t \hyperlink{class_nex_slider_ab98752f15d56dc04de102c0c2180ea11}{get\+Minval} (uint32\+\_\+t $\ast$number)
\item
bool \hyperlink{class_nex_slider_ad38503fd3a6bfe3eaaa57764ac90f244}{set\+Minval} (uint32\+\_\+t number)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}
\subsection{Detailed Description}
\hyperlink{class_nex_slider}{Nex\+Slider} component.
\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_nex_slider_a00c5678209c936e9a57c14b6e2384774}{\index{Nex\+Slider@{Nex\+Slider}!Nex\+Slider@{Nex\+Slider}}
\index{Nex\+Slider@{Nex\+Slider}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Nex\+Slider}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Slider\+::\+Nex\+Slider (
\begin{DoxyParamCaption}
\item[{uint8\+\_\+t}]{pid, }
\item[{uint8\+\_\+t}]{cid, }
\item[{const char $\ast$}]{name}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a00c5678209c936e9a57c14b6e2384774}
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_slider_a1cf49184702852c0623a695f4b62b1ed}{\index{Nex\+Slider@{Nex\+Slider}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a1cf49184702852c0623a695f4b62b1ed}
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_slider_a680c31b1aa2dc48a1193c9d8fb3cd487}{\index{Nex\+Slider@{Nex\+Slider}!Get\+\_\+cursor\+\_\+height\+\_\+hig@{Get\+\_\+cursor\+\_\+height\+\_\+hig}}
\index{Get\+\_\+cursor\+\_\+height\+\_\+hig@{Get\+\_\+cursor\+\_\+height\+\_\+hig}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Get\+\_\+cursor\+\_\+height\+\_\+hig}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::\+Get\+\_\+cursor\+\_\+height\+\_\+hig (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a680c31b1aa2dc48a1193c9d8fb3cd487}
Get hig 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_slider_aa6361627b3c66ee7a569b5cfec4ce562}{\index{Nex\+Slider@{Nex\+Slider}!Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}}
\index{Get\+\_\+font\+\_\+color\+\_\+pco@{Get\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Get\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::\+Get\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_aa6361627b3c66ee7a569b5cfec4ce562}
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_slider_a6adbc43b663e3542a92641c406db23ad}{\index{Nex\+Slider@{Nex\+Slider}!Get\+\_\+pointer\+\_\+thickness\+\_\+wid@{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}}
\index{Get\+\_\+pointer\+\_\+thickness\+\_\+wid@{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Get\+\_\+pointer\+\_\+thickness\+\_\+wid}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::\+Get\+\_\+pointer\+\_\+thickness\+\_\+wid (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a6adbc43b663e3542a92641c406db23ad}
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_slider_abf1b50605feb0ac2b381d1148795f0d9}{\index{Nex\+Slider@{Nex\+Slider}!get\+Maxval@{get\+Maxval}}
\index{get\+Maxval@{get\+Maxval}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{get\+Maxval}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::get\+Maxval (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_abf1b50605feb0ac2b381d1148795f0d9}
Get maxval 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_slider_ab98752f15d56dc04de102c0c2180ea11}{\index{Nex\+Slider@{Nex\+Slider}!get\+Minval@{get\+Minval}}
\index{get\+Minval@{get\+Minval}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{get\+Minval}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Slider\+::get\+Minval (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_ab98752f15d56dc04de102c0c2180ea11}
Get minval 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_slider_a384d5488b421efd6affbfd32f45bb107}{\index{Nex\+Slider@{Nex\+Slider}!get\+Value@{get\+Value}}
\index{get\+Value@{get\+Value}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{get\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::get\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a384d5488b421efd6affbfd32f45bb107}
Get the value of slider.
\begin{DoxyParams}{Parameters}
{\em number} & -\/ an output parameter to save the value of slider.\\
\hline
\end{DoxyParams}
\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}
\hypertarget{class_nex_slider_ac22c66fecb8cf03d554c3c86e6e798d5}{\index{Nex\+Slider@{Nex\+Slider}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_ac22c66fecb8cf03d554c3c86e6e798d5}
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_slider_a603cf3685c6d843261d8552030af9f22}{\index{Nex\+Slider@{Nex\+Slider}!Set\+\_\+cursor\+\_\+height\+\_\+hig@{Set\+\_\+cursor\+\_\+height\+\_\+hig}}
\index{Set\+\_\+cursor\+\_\+height\+\_\+hig@{Set\+\_\+cursor\+\_\+height\+\_\+hig}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Set\+\_\+cursor\+\_\+height\+\_\+hig}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::\+Set\+\_\+cursor\+\_\+height\+\_\+hig (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a603cf3685c6d843261d8552030af9f22}
Set hig 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_slider_acc766d430c7a663846e4da6e1bacf76c}{\index{Nex\+Slider@{Nex\+Slider}!Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}}
\index{Set\+\_\+font\+\_\+color\+\_\+pco@{Set\+\_\+font\+\_\+color\+\_\+pco}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Set\+\_\+font\+\_\+color\+\_\+pco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::\+Set\+\_\+font\+\_\+color\+\_\+pco (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_acc766d430c7a663846e4da6e1bacf76c}
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_slider_a6b91c1f7fddf7ea1b62c406453110ead}{\index{Nex\+Slider@{Nex\+Slider}!Set\+\_\+pointer\+\_\+thickness\+\_\+wid@{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}}
\index{Set\+\_\+pointer\+\_\+thickness\+\_\+wid@{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{Set\+\_\+pointer\+\_\+thickness\+\_\+wid}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::\+Set\+\_\+pointer\+\_\+thickness\+\_\+wid (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a6b91c1f7fddf7ea1b62c406453110ead}
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_slider_a5a1c65a9f2e21a624b78d5817d695503}{\index{Nex\+Slider@{Nex\+Slider}!set\+Maxval@{set\+Maxval}}
\index{set\+Maxval@{set\+Maxval}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{set\+Maxval}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::set\+Maxval (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a5a1c65a9f2e21a624b78d5817d695503}
Set maxval 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_slider_ad38503fd3a6bfe3eaaa57764ac90f244}{\index{Nex\+Slider@{Nex\+Slider}!set\+Minval@{set\+Minval}}
\index{set\+Minval@{set\+Minval}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{set\+Minval}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::set\+Minval (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_ad38503fd3a6bfe3eaaa57764ac90f244}
Set minval 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_slider_a3f325bda4db913e302e94a4b25de7b5f}{\index{Nex\+Slider@{Nex\+Slider}!set\+Value@{set\+Value}}
\index{set\+Value@{set\+Value}!Nex\+Slider@{Nex\+Slider}}
\subsubsection[{set\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Slider\+::set\+Value (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_slider_a3f325bda4db913e302e94a4b25de7b5f}
Set the value of slider.
\begin{DoxyParams}{Parameters}
{\em number} & -\/ the value of slider.\\
\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_slider_8h}{Nex\+Slider.\+h}\item
\hyperlink{_nex_slider_8cpp}{Nex\+Slider.\+cpp}\end{DoxyCompactItemize}