278 lines
15 KiB
TeX
278 lines
15 KiB
TeX
\hypertarget{class_boxing_settings}{}\section{Boxing\+Settings Class Reference}
|
|
\label{class_boxing_settings}\index{Boxing\+Settings@{Boxing\+Settings}}
|
|
|
|
|
|
Handle settings about timer. Can save, load and delete a specific preset.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$boxingsettings.\+h$>$}
|
|
|
|
Inheritance diagram for Boxing\+Settings\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.000000cm]{class_boxing_settings}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Signals}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \hyperlink{class_boxing_settings_a811dbd6c80f86ad219bbb9166571a2e9}{preset\+Changed} ()
|
|
\end{DoxyCompactItemize}
|
|
\subsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE const Q\+String\+List \hyperlink{class_boxing_settings_a507b3038f2851cff0d17fffc027019de}{presets\+List} ()
|
|
\item
|
|
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE void \hyperlink{class_boxing_settings_a8402eca09f44d4b3773ac1fd12e8dcda}{save\+Preset} (const Q\+String \&name, const int \&rounds, const int \&round\+Milliseconds, const int \&rest\+Milliseconds, const Q\+List$<$ int $>$ \&inner\+Timers)
|
|
\begin{DoxyCompactList}\small\item\em Save or override settings about specific preset. \end{DoxyCompactList}\item
|
|
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE void \hyperlink{class_boxing_settings_a6475be7b9b7eacc3b4a9ca853311b5a9}{delete\+Preset} (const Q\+String \&name)
|
|
\begin{DoxyCompactList}\small\item\em Delete a specified preset. \end{DoxyCompactList}\item
|
|
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE int \hyperlink{class_boxing_settings_a7ddc31fa4c9bea682674cb938d2d9e24}{get\+Inner\+Timer} (const int \&index)
|
|
\begin{DoxyCompactList}\small\item\em \hyperlink{class_boxing_settings_a7ddc31fa4c9bea682674cb938d2d9e24}{get\+Inner\+Timer(const int \&index)} \end{DoxyCompactList}\item
|
|
\hyperlink{class_boxing_settings_a62af206ef42670b751e0cec59c206896}{Boxing\+Settings} ()
|
|
\item
|
|
\hyperlink{class_boxing_settings_a6dc7071565573dbd59d3eb94613b2433}{Boxing\+Settings} (const int \&rounds, const int \&round\+Milliseconds, const int \&rest\+Milliseconds)
|
|
\item
|
|
int \hyperlink{class_boxing_settings_ae57079ed791d793bfb310712063b1dab}{get\+Rounds} ()
|
|
\item
|
|
int \hyperlink{class_boxing_settings_a2b9ff4ab1dbd14f5e8f37b88677e73f4}{get\+Round\+Milliseconds} ()
|
|
\item
|
|
int \hyperlink{class_boxing_settings_a84fd6052ef19488b015638c68fa2be72}{get\+Rest\+Milliseconds} ()
|
|
\item
|
|
Q\+List$<$ int $>$ \hyperlink{class_boxing_settings_abdabae9cd200706c2d207ada15b1c04c}{get\+Inner\+Timers} ()
|
|
\begin{DoxyCompactList}\small\item\em ger\+Inner\+Timers() \end{DoxyCompactList}\item
|
|
Q\+String \hyperlink{class_boxing_settings_a2d03c793ed7ad6e97894e21b1f85105b}{get\+Preset} ()
|
|
\item
|
|
Q\+String \hyperlink{class_boxing_settings_ac0641004a9f244dcce8056c722685065}{get\+Preset\+Name} ()
|
|
\item
|
|
void \hyperlink{class_boxing_settings_a5fee80840f4bfe8cb0fa95dea161e586}{set\+Rounds} (const int \&rounds)
|
|
\begin{DoxyCompactList}\small\item\em Setter for number of rounds. \end{DoxyCompactList}\item
|
|
void \hyperlink{class_boxing_settings_aaa691ab3a2fa5d1812975207b7e9f9ed}{set\+Round\+Milliseconds} (const int \&round\+Milliseconds)
|
|
\begin{DoxyCompactList}\small\item\em Setter for duration of round (in milliseconds) \end{DoxyCompactList}\item
|
|
void \hyperlink{class_boxing_settings_ad7c283d2b4ebe1333c1680a0fd19cb0c}{set\+Rest\+Milliseconds} (const int \&rest\+Milliseconds)
|
|
\begin{DoxyCompactList}\small\item\em Setter for milliseconds of rest. \end{DoxyCompactList}\item
|
|
void \hyperlink{class_boxing_settings_a71e6d017856266fa95b07ed0030ed05b}{set\+Preset} (const Q\+String \&preset)
|
|
\begin{DoxyCompactList}\small\item\em Setter for preset. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
Handle settings about timer. Can save, load and delete a specific preset.
|
|
|
|
Q\+ML Part of view
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{class_boxing_settings_a62af206ef42670b751e0cec59c206896}\label{class_boxing_settings_a62af206ef42670b751e0cec59c206896}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{Boxing\+Settings()}{BoxingSettings()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
|
|
{\footnotesize\ttfamily Boxing\+Settings\+::\+Boxing\+Settings (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
\mbox{\Hypertarget{class_boxing_settings_a6dc7071565573dbd59d3eb94613b2433}\label{class_boxing_settings_a6dc7071565573dbd59d3eb94613b2433}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{Boxing\+Settings()}{BoxingSettings()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
|
|
{\footnotesize\ttfamily Boxing\+Settings\+::\+Boxing\+Settings (\begin{DoxyParamCaption}\item[{const int \&}]{rounds, }\item[{const int \&}]{round\+Milliseconds, }\item[{const int \&}]{rest\+Milliseconds }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
\subsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_boxing_settings_a6475be7b9b7eacc3b4a9ca853311b5a9}\label{class_boxing_settings_a6475be7b9b7eacc3b4a9ca853311b5a9}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!delete\+Preset@{delete\+Preset}}
|
|
\index{delete\+Preset@{delete\+Preset}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{delete\+Preset()}{deletePreset()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::delete\+Preset (\begin{DoxyParamCaption}\item[{const Q\+String \&}]{name }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Delete a specified preset.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & string name of preset\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyAuthor}{Author}
|
|
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
|
\end{DoxyAuthor}
|
|
\mbox{\Hypertarget{class_boxing_settings_a7ddc31fa4c9bea682674cb938d2d9e24}\label{class_boxing_settings_a7ddc31fa4c9bea682674cb938d2d9e24}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Inner\+Timer@{get\+Inner\+Timer}}
|
|
\index{get\+Inner\+Timer@{get\+Inner\+Timer}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Inner\+Timer()}{getInnerTimer()}}
|
|
{\footnotesize\ttfamily int Boxing\+Settings\+::get\+Inner\+Timer (\begin{DoxyParamCaption}\item[{const int \&}]{index }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
\hyperlink{class_boxing_settings_a7ddc31fa4c9bea682674cb938d2d9e24}{get\+Inner\+Timer(const int \&index)}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
the specific timer in milliseconds
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_abdabae9cd200706c2d207ada15b1c04c}\label{class_boxing_settings_abdabae9cd200706c2d207ada15b1c04c}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Inner\+Timers@{get\+Inner\+Timers}}
|
|
\index{get\+Inner\+Timers@{get\+Inner\+Timers}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Inner\+Timers()}{getInnerTimers()}}
|
|
{\footnotesize\ttfamily Q\+List$<$int$>$ Boxing\+Settings\+::get\+Inner\+Timers (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
ger\+Inner\+Timers()
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
the list of inner timers
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_a2d03c793ed7ad6e97894e21b1f85105b}\label{class_boxing_settings_a2d03c793ed7ad6e97894e21b1f85105b}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Preset@{get\+Preset}}
|
|
\index{get\+Preset@{get\+Preset}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Preset()}{getPreset()}}
|
|
{\footnotesize\ttfamily Q\+String Boxing\+Settings\+::get\+Preset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
the loaded preset
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_ac0641004a9f244dcce8056c722685065}\label{class_boxing_settings_ac0641004a9f244dcce8056c722685065}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Preset\+Name@{get\+Preset\+Name}}
|
|
\index{get\+Preset\+Name@{get\+Preset\+Name}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Preset\+Name()}{getPresetName()}}
|
|
{\footnotesize\ttfamily Q\+String Boxing\+Settings\+::get\+Preset\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
the human readable name of preset
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_a84fd6052ef19488b015638c68fa2be72}\label{class_boxing_settings_a84fd6052ef19488b015638c68fa2be72}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Rest\+Milliseconds@{get\+Rest\+Milliseconds}}
|
|
\index{get\+Rest\+Milliseconds@{get\+Rest\+Milliseconds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Rest\+Milliseconds()}{getRestMilliseconds()}}
|
|
{\footnotesize\ttfamily int Boxing\+Settings\+::get\+Rest\+Milliseconds (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
milliseconds of rest
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_a2b9ff4ab1dbd14f5e8f37b88677e73f4}\label{class_boxing_settings_a2b9ff4ab1dbd14f5e8f37b88677e73f4}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Round\+Milliseconds@{get\+Round\+Milliseconds}}
|
|
\index{get\+Round\+Milliseconds@{get\+Round\+Milliseconds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Round\+Milliseconds()}{getRoundMilliseconds()}}
|
|
{\footnotesize\ttfamily int Boxing\+Settings\+::get\+Round\+Milliseconds (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
duration in milliseconds of a rounds
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_ae57079ed791d793bfb310712063b1dab}\label{class_boxing_settings_ae57079ed791d793bfb310712063b1dab}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!get\+Rounds@{get\+Rounds}}
|
|
\index{get\+Rounds@{get\+Rounds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{get\+Rounds()}{getRounds()}}
|
|
{\footnotesize\ttfamily int Boxing\+Settings\+::get\+Rounds (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
number of rounds
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_a811dbd6c80f86ad219bbb9166571a2e9}\label{class_boxing_settings_a811dbd6c80f86ad219bbb9166571a2e9}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!preset\+Changed@{preset\+Changed}}
|
|
\index{preset\+Changed@{preset\+Changed}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{preset\+Changed}{presetChanged}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::preset\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
|
|
|
\mbox{\Hypertarget{class_boxing_settings_a507b3038f2851cff0d17fffc027019de}\label{class_boxing_settings_a507b3038f2851cff0d17fffc027019de}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!presets\+List@{presets\+List}}
|
|
\index{presets\+List@{presets\+List}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{presets\+List()}{presetsList()}}
|
|
{\footnotesize\ttfamily const Q\+String\+List Boxing\+Settings\+::presets\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
|
\end{DoxyAuthor}
|
|
\begin{DoxyReturn}{Returns}
|
|
a list with available (probably saved) presets
|
|
\end{DoxyReturn}
|
|
\mbox{\Hypertarget{class_boxing_settings_a8402eca09f44d4b3773ac1fd12e8dcda}\label{class_boxing_settings_a8402eca09f44d4b3773ac1fd12e8dcda}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!save\+Preset@{save\+Preset}}
|
|
\index{save\+Preset@{save\+Preset}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{save\+Preset()}{savePreset()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::save\+Preset (\begin{DoxyParamCaption}\item[{const Q\+String \&}]{name, }\item[{const int \&}]{rounds, }\item[{const int \&}]{round\+Milliseconds, }\item[{const int \&}]{rest\+Milliseconds, }\item[{const Q\+List$<$ int $>$ \&}]{inner\+Timers }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Save or override settings about specific preset.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em name} & string name of preset \\
|
|
\hline
|
|
{\em rounds} & int number of rounds \\
|
|
\hline
|
|
{\em round\+Milliseconds} & int duration of round \\
|
|
\hline
|
|
{\em rest\+Milliseconds} & int duration of rest\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyAuthor}{Author}
|
|
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
|
\end{DoxyAuthor}
|
|
\mbox{\Hypertarget{class_boxing_settings_a71e6d017856266fa95b07ed0030ed05b}\label{class_boxing_settings_a71e6d017856266fa95b07ed0030ed05b}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!set\+Preset@{set\+Preset}}
|
|
\index{set\+Preset@{set\+Preset}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{set\+Preset()}{setPreset()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::set\+Preset (\begin{DoxyParamCaption}\item[{const Q\+String \&}]{preset }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Setter for preset.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em preset} & Q\+String \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{class_boxing_settings_ad7c283d2b4ebe1333c1680a0fd19cb0c}\label{class_boxing_settings_ad7c283d2b4ebe1333c1680a0fd19cb0c}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!set\+Rest\+Milliseconds@{set\+Rest\+Milliseconds}}
|
|
\index{set\+Rest\+Milliseconds@{set\+Rest\+Milliseconds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{set\+Rest\+Milliseconds()}{setRestMilliseconds()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::set\+Rest\+Milliseconds (\begin{DoxyParamCaption}\item[{const int \&}]{rest\+Milliseconds }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Setter for milliseconds of rest.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em rest\+Milliseconds} & int \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{class_boxing_settings_aaa691ab3a2fa5d1812975207b7e9f9ed}\label{class_boxing_settings_aaa691ab3a2fa5d1812975207b7e9f9ed}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!set\+Round\+Milliseconds@{set\+Round\+Milliseconds}}
|
|
\index{set\+Round\+Milliseconds@{set\+Round\+Milliseconds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{set\+Round\+Milliseconds()}{setRoundMilliseconds()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::set\+Round\+Milliseconds (\begin{DoxyParamCaption}\item[{const int \&}]{round\+Milliseconds }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Setter for duration of round (in milliseconds)
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em round\+Milliseconds} & int \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\mbox{\Hypertarget{class_boxing_settings_a5fee80840f4bfe8cb0fa95dea161e586}\label{class_boxing_settings_a5fee80840f4bfe8cb0fa95dea161e586}}
|
|
\index{Boxing\+Settings@{Boxing\+Settings}!set\+Rounds@{set\+Rounds}}
|
|
\index{set\+Rounds@{set\+Rounds}!Boxing\+Settings@{Boxing\+Settings}}
|
|
\subsubsection{\texorpdfstring{set\+Rounds()}{setRounds()}}
|
|
{\footnotesize\ttfamily void Boxing\+Settings\+::set\+Rounds (\begin{DoxyParamCaption}\item[{const int \&}]{rounds }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Setter for number of rounds.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em rounds} & int \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
src/\hyperlink{boxingsettings_8h}{boxingsettings.\+h}\item
|
|
src/\hyperlink{boxingsettings_8cpp}{boxingsettings.\+cpp}\end{DoxyCompactItemize}
|