First commit
This commit is contained in:
5
documentation/latex/annotated.tex
Normal file
5
documentation/latex/annotated.tex
Normal file
@ -0,0 +1,5 @@
|
||||
\section{Class List}
|
||||
Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{\hyperlink{class_boxing_settings}{Boxing\+Settings} \\*Handle settings about timer. Can save, load and delete a specific preset }{\pageref{class_boxing_settings}}{}
|
||||
\item\contentsline{section}{\hyperlink{class_boxing_timer}{Boxing\+Timer} \\*Boxing timer class }{\pageref{class_boxing_timer}}{}
|
||||
\end{DoxyCompactList}
|
||||
4
documentation/latex/boxingsettings_8cpp.tex
Normal file
4
documentation/latex/boxingsettings_8cpp.tex
Normal file
@ -0,0 +1,4 @@
|
||||
\hypertarget{boxingsettings_8cpp}{}\section{src/boxingsettings.cpp File Reference}
|
||||
\label{boxingsettings_8cpp}\index{src/boxingsettings.\+cpp@{src/boxingsettings.\+cpp}}
|
||||
{\ttfamily \#include \char`\"{}boxingsettings.\+h\char`\"{}}\newline
|
||||
{\ttfamily \#include $<$Q\+String$>$}\newline
|
||||
10
documentation/latex/boxingsettings_8h.tex
Normal file
10
documentation/latex/boxingsettings_8h.tex
Normal file
@ -0,0 +1,10 @@
|
||||
\hypertarget{boxingsettings_8h}{}\section{src/boxingsettings.h File Reference}
|
||||
\label{boxingsettings_8h}\index{src/boxingsettings.\+h@{src/boxingsettings.\+h}}
|
||||
{\ttfamily \#include $<$Q\+String$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+String\+List$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+Settings$>$}\newline
|
||||
\subsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \hyperlink{class_boxing_settings}{Boxing\+Settings}
|
||||
\begin{DoxyCompactList}\small\item\em Handle settings about timer. Can save, load and delete a specific preset. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
7
documentation/latex/boxingtimer_8cpp.tex
Normal file
7
documentation/latex/boxingtimer_8cpp.tex
Normal file
@ -0,0 +1,7 @@
|
||||
\hypertarget{boxingtimer_8cpp}{}\section{src/boxingtimer.cpp File Reference}
|
||||
\label{boxingtimer_8cpp}\index{src/boxingtimer.\+cpp@{src/boxingtimer.\+cpp}}
|
||||
{\ttfamily \#include $<$Q\+Object$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+Time$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+Settings$>$}\newline
|
||||
{\ttfamily \#include \char`\"{}boxingtimer.\+h\char`\"{}}\newline
|
||||
{\ttfamily \#include \char`\"{}boxingsettings.\+h\char`\"{}}\newline
|
||||
10
documentation/latex/boxingtimer_8h.tex
Normal file
10
documentation/latex/boxingtimer_8h.tex
Normal file
@ -0,0 +1,10 @@
|
||||
\hypertarget{boxingtimer_8h}{}\section{src/boxingtimer.h File Reference}
|
||||
\label{boxingtimer_8h}\index{src/boxingtimer.\+h@{src/boxingtimer.\+h}}
|
||||
{\ttfamily \#include $<$Q\+Timer$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+String$>$}\newline
|
||||
{\ttfamily \#include $<$Q\+String\+List$>$}\newline
|
||||
\subsection*{Classes}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
class \hyperlink{class_boxing_timer}{Boxing\+Timer}
|
||||
\begin{DoxyCompactList}\small\item\em Boxing timer class. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
197
documentation/latex/class_boxing_settings.eps
Normal file
197
documentation/latex/class_boxing_settings.eps
Normal file
@ -0,0 +1,197 @@
|
||||
%!PS-Adobe-2.0 EPSF-2.0
|
||||
%%Title: ClassName
|
||||
%%Creator: Doxygen
|
||||
%%CreationDate: Time
|
||||
%%For:
|
||||
%Magnification: 1.00
|
||||
%%Orientation: Portrait
|
||||
%%BoundingBox: 0 0 500 392.156863
|
||||
%%Pages: 0
|
||||
%%BeginSetup
|
||||
%%EndSetup
|
||||
%%EndComments
|
||||
|
||||
% ----- variables -----
|
||||
|
||||
/boxwidth 0 def
|
||||
/boxheight 40 def
|
||||
/fontheight 24 def
|
||||
/marginwidth 10 def
|
||||
/distx 20 def
|
||||
/disty 40 def
|
||||
/boundaspect 1.275000 def % aspect ratio of the BoundingBox (width/height)
|
||||
/boundx 500 def
|
||||
/boundy boundx boundaspect div def
|
||||
/xspacing 0 def
|
||||
/yspacing 0 def
|
||||
/rows 2 def
|
||||
/cols 1 def
|
||||
/scalefactor 0 def
|
||||
/boxfont /Times-Roman findfont fontheight scalefont def
|
||||
|
||||
% ----- procedures -----
|
||||
|
||||
/dotted { [1 4] 0 setdash } def
|
||||
/dashed { [5] 0 setdash } def
|
||||
/solid { [] 0 setdash } def
|
||||
|
||||
/max % result = MAX(arg1,arg2)
|
||||
{
|
||||
/a exch def
|
||||
/b exch def
|
||||
a b gt {a} {b} ifelse
|
||||
} def
|
||||
|
||||
/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2)
|
||||
{
|
||||
0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max
|
||||
} def
|
||||
|
||||
/cw % boxwidth = MAX(boxwidth, stringwidth(arg1))
|
||||
{
|
||||
/str exch def
|
||||
/boxwidth boxwidth str stringwidth pop max def
|
||||
} def
|
||||
|
||||
/box % draws a box with text `arg1' at grid pos (arg2,arg3)
|
||||
{ gsave
|
||||
2 setlinewidth
|
||||
newpath
|
||||
exch xspacing mul xoffset add
|
||||
exch yspacing mul
|
||||
moveto
|
||||
boxwidth 0 rlineto
|
||||
0 boxheight rlineto
|
||||
boxwidth neg 0 rlineto
|
||||
0 boxheight neg rlineto
|
||||
closepath
|
||||
dup stringwidth pop neg boxwidth add 2 div
|
||||
boxheight fontheight 2 div sub 2 div
|
||||
rmoveto show stroke
|
||||
grestore
|
||||
} def
|
||||
|
||||
/mark
|
||||
{ newpath
|
||||
exch xspacing mul xoffset add boxwidth add
|
||||
exch yspacing mul
|
||||
moveto
|
||||
0 boxheight 4 div rlineto
|
||||
boxheight neg 4 div boxheight neg 4 div rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} def
|
||||
|
||||
/arrow
|
||||
{ newpath
|
||||
moveto
|
||||
3 -8 rlineto
|
||||
-6 0 rlineto
|
||||
3 8 rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} def
|
||||
|
||||
/out % draws an output connector for the block at (arg1,arg2)
|
||||
{
|
||||
newpath
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul boxheight add
|
||||
/y exch def
|
||||
/x exch def
|
||||
x y moveto
|
||||
0 disty 2 div rlineto
|
||||
stroke
|
||||
1 eq { x y disty 2 div add arrow } if
|
||||
} def
|
||||
|
||||
/in % draws an input connector for the block at (arg1,arg2)
|
||||
{
|
||||
newpath
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul disty 2 div sub
|
||||
/y exch def
|
||||
/x exch def
|
||||
x y moveto
|
||||
0 disty 2 div rlineto
|
||||
stroke
|
||||
1 eq { x y disty 2 div add arrow } if
|
||||
} def
|
||||
|
||||
/hedge
|
||||
{
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul boxheight 2 div sub
|
||||
/y exch def
|
||||
/x exch def
|
||||
newpath
|
||||
x y moveto
|
||||
boxwidth 2 div distx add 0 rlineto
|
||||
stroke
|
||||
1 eq
|
||||
{ newpath x boxwidth 2 div distx add add y moveto
|
||||
-8 3 rlineto
|
||||
0 -6 rlineto
|
||||
8 3 rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} if
|
||||
} def
|
||||
|
||||
/vedge
|
||||
{
|
||||
/ye exch def
|
||||
/ys exch def
|
||||
/xs exch def
|
||||
newpath
|
||||
xs xspacing mul xoffset add boxwidth 2 div add dup
|
||||
ys yspacing mul boxheight 2 div sub
|
||||
moveto
|
||||
ye yspacing mul boxheight 2 div sub
|
||||
lineto
|
||||
stroke
|
||||
} def
|
||||
|
||||
/conn % connections the blocks from col `arg1' to `arg2' of row `arg3'
|
||||
{
|
||||
/ys exch def
|
||||
/xe exch def
|
||||
/xs exch def
|
||||
newpath
|
||||
xs xspacing mul xoffset add boxwidth 2 div add
|
||||
ys yspacing mul disty 2 div sub
|
||||
moveto
|
||||
xspacing xe xs sub mul 0
|
||||
rlineto
|
||||
stroke
|
||||
} def
|
||||
|
||||
% ----- main ------
|
||||
|
||||
boxfont setfont
|
||||
1 boundaspect scale
|
||||
(BoxingSettings) cw
|
||||
(QSettings) cw
|
||||
/boxwidth boxwidth marginwidth 2 mul add def
|
||||
/xspacing boxwidth distx add def
|
||||
/yspacing boxheight disty add def
|
||||
/scalefactor
|
||||
boxwidth cols mul distx cols 1 sub mul add
|
||||
boxheight rows mul disty rows 1 sub mul add boundaspect mul
|
||||
max def
|
||||
boundx scalefactor div boundy scalefactor div scale
|
||||
|
||||
% ----- classes -----
|
||||
|
||||
(BoxingSettings) 0.000000 0.000000 box
|
||||
(QSettings) 0.000000 1.000000 box
|
||||
|
||||
% ----- relations -----
|
||||
|
||||
solid
|
||||
0 0.000000 0.000000 out
|
||||
solid
|
||||
1 0.000000 1.000000 in
|
||||
BIN
documentation/latex/class_boxing_settings.pdf
Normal file
BIN
documentation/latex/class_boxing_settings.pdf
Normal file
Binary file not shown.
247
documentation/latex/class_boxing_settings.tex
Normal file
247
documentation/latex/class_boxing_settings.tex
Normal file
@ -0,0 +1,247 @@
|
||||
\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_a24906b544896052c08f0b93ded92823b}{save\+Preset} (const Q\+String \&name, const int \&rounds, const int \&round\+Milliseconds, const int \&rest\+Milliseconds)
|
||||
\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
|
||||
\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\+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_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_a24906b544896052c08f0b93ded92823b}\label{class_boxing_settings_a24906b544896052c08f0b93ded92823b}}
|
||||
\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 }\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}
|
||||
197
documentation/latex/class_boxing_timer.eps
Normal file
197
documentation/latex/class_boxing_timer.eps
Normal file
@ -0,0 +1,197 @@
|
||||
%!PS-Adobe-2.0 EPSF-2.0
|
||||
%%Title: ClassName
|
||||
%%Creator: Doxygen
|
||||
%%CreationDate: Time
|
||||
%%For:
|
||||
%Magnification: 1.00
|
||||
%%Orientation: Portrait
|
||||
%%BoundingBox: 0 0 500 449.438202
|
||||
%%Pages: 0
|
||||
%%BeginSetup
|
||||
%%EndSetup
|
||||
%%EndComments
|
||||
|
||||
% ----- variables -----
|
||||
|
||||
/boxwidth 0 def
|
||||
/boxheight 40 def
|
||||
/fontheight 24 def
|
||||
/marginwidth 10 def
|
||||
/distx 20 def
|
||||
/disty 40 def
|
||||
/boundaspect 1.112500 def % aspect ratio of the BoundingBox (width/height)
|
||||
/boundx 500 def
|
||||
/boundy boundx boundaspect div def
|
||||
/xspacing 0 def
|
||||
/yspacing 0 def
|
||||
/rows 2 def
|
||||
/cols 1 def
|
||||
/scalefactor 0 def
|
||||
/boxfont /Times-Roman findfont fontheight scalefont def
|
||||
|
||||
% ----- procedures -----
|
||||
|
||||
/dotted { [1 4] 0 setdash } def
|
||||
/dashed { [5] 0 setdash } def
|
||||
/solid { [] 0 setdash } def
|
||||
|
||||
/max % result = MAX(arg1,arg2)
|
||||
{
|
||||
/a exch def
|
||||
/b exch def
|
||||
a b gt {a} {b} ifelse
|
||||
} def
|
||||
|
||||
/xoffset % result = MAX(0,(scalefactor-(boxwidth*cols+distx*(cols-1)))/2)
|
||||
{
|
||||
0 scalefactor boxwidth cols mul distx cols 1 sub mul add sub 2 div max
|
||||
} def
|
||||
|
||||
/cw % boxwidth = MAX(boxwidth, stringwidth(arg1))
|
||||
{
|
||||
/str exch def
|
||||
/boxwidth boxwidth str stringwidth pop max def
|
||||
} def
|
||||
|
||||
/box % draws a box with text `arg1' at grid pos (arg2,arg3)
|
||||
{ gsave
|
||||
2 setlinewidth
|
||||
newpath
|
||||
exch xspacing mul xoffset add
|
||||
exch yspacing mul
|
||||
moveto
|
||||
boxwidth 0 rlineto
|
||||
0 boxheight rlineto
|
||||
boxwidth neg 0 rlineto
|
||||
0 boxheight neg rlineto
|
||||
closepath
|
||||
dup stringwidth pop neg boxwidth add 2 div
|
||||
boxheight fontheight 2 div sub 2 div
|
||||
rmoveto show stroke
|
||||
grestore
|
||||
} def
|
||||
|
||||
/mark
|
||||
{ newpath
|
||||
exch xspacing mul xoffset add boxwidth add
|
||||
exch yspacing mul
|
||||
moveto
|
||||
0 boxheight 4 div rlineto
|
||||
boxheight neg 4 div boxheight neg 4 div rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} def
|
||||
|
||||
/arrow
|
||||
{ newpath
|
||||
moveto
|
||||
3 -8 rlineto
|
||||
-6 0 rlineto
|
||||
3 8 rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} def
|
||||
|
||||
/out % draws an output connector for the block at (arg1,arg2)
|
||||
{
|
||||
newpath
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul boxheight add
|
||||
/y exch def
|
||||
/x exch def
|
||||
x y moveto
|
||||
0 disty 2 div rlineto
|
||||
stroke
|
||||
1 eq { x y disty 2 div add arrow } if
|
||||
} def
|
||||
|
||||
/in % draws an input connector for the block at (arg1,arg2)
|
||||
{
|
||||
newpath
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul disty 2 div sub
|
||||
/y exch def
|
||||
/x exch def
|
||||
x y moveto
|
||||
0 disty 2 div rlineto
|
||||
stroke
|
||||
1 eq { x y disty 2 div add arrow } if
|
||||
} def
|
||||
|
||||
/hedge
|
||||
{
|
||||
exch xspacing mul xoffset add boxwidth 2 div add
|
||||
exch yspacing mul boxheight 2 div sub
|
||||
/y exch def
|
||||
/x exch def
|
||||
newpath
|
||||
x y moveto
|
||||
boxwidth 2 div distx add 0 rlineto
|
||||
stroke
|
||||
1 eq
|
||||
{ newpath x boxwidth 2 div distx add add y moveto
|
||||
-8 3 rlineto
|
||||
0 -6 rlineto
|
||||
8 3 rlineto
|
||||
closepath
|
||||
eofill
|
||||
stroke
|
||||
} if
|
||||
} def
|
||||
|
||||
/vedge
|
||||
{
|
||||
/ye exch def
|
||||
/ys exch def
|
||||
/xs exch def
|
||||
newpath
|
||||
xs xspacing mul xoffset add boxwidth 2 div add dup
|
||||
ys yspacing mul boxheight 2 div sub
|
||||
moveto
|
||||
ye yspacing mul boxheight 2 div sub
|
||||
lineto
|
||||
stroke
|
||||
} def
|
||||
|
||||
/conn % connections the blocks from col `arg1' to `arg2' of row `arg3'
|
||||
{
|
||||
/ys exch def
|
||||
/xe exch def
|
||||
/xs exch def
|
||||
newpath
|
||||
xs xspacing mul xoffset add boxwidth 2 div add
|
||||
ys yspacing mul disty 2 div sub
|
||||
moveto
|
||||
xspacing xe xs sub mul 0
|
||||
rlineto
|
||||
stroke
|
||||
} def
|
||||
|
||||
% ----- main ------
|
||||
|
||||
boxfont setfont
|
||||
1 boundaspect scale
|
||||
(BoxingTimer) cw
|
||||
(QTimer) cw
|
||||
/boxwidth boxwidth marginwidth 2 mul add def
|
||||
/xspacing boxwidth distx add def
|
||||
/yspacing boxheight disty add def
|
||||
/scalefactor
|
||||
boxwidth cols mul distx cols 1 sub mul add
|
||||
boxheight rows mul disty rows 1 sub mul add boundaspect mul
|
||||
max def
|
||||
boundx scalefactor div boundy scalefactor div scale
|
||||
|
||||
% ----- classes -----
|
||||
|
||||
(BoxingTimer) 0.000000 0.000000 box
|
||||
(QTimer) 0.000000 1.000000 box
|
||||
|
||||
% ----- relations -----
|
||||
|
||||
solid
|
||||
0 0.000000 0.000000 out
|
||||
solid
|
||||
1 0.000000 1.000000 in
|
||||
BIN
documentation/latex/class_boxing_timer.pdf
Normal file
BIN
documentation/latex/class_boxing_timer.pdf
Normal file
Binary file not shown.
310
documentation/latex/class_boxing_timer.tex
Normal file
310
documentation/latex/class_boxing_timer.tex
Normal file
@ -0,0 +1,310 @@
|
||||
\hypertarget{class_boxing_timer}{}\section{Boxing\+Timer Class Reference}
|
||||
\label{class_boxing_timer}\index{Boxing\+Timer@{Boxing\+Timer}}
|
||||
|
||||
|
||||
Boxing timer class.
|
||||
|
||||
|
||||
|
||||
|
||||
{\ttfamily \#include $<$boxingtimer.\+h$>$}
|
||||
|
||||
Inheritance diagram for Boxing\+Timer\+:\begin{figure}[H]
|
||||
\begin{center}
|
||||
\leavevmode
|
||||
\includegraphics[height=2.000000cm]{class_boxing_timer}
|
||||
\end{center}
|
||||
\end{figure}
|
||||
\subsection*{Public Types}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
enum \hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Status} \+: short \{ \newline
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a7a1920d61156abc05a60135aefe8bc67}{Status\+::\+Default} = 0,
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558aa6122a65eaa676f700ae68d393054a37}{Status\+::\+Start},
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a55276c10d84e1df7713b441e76e141f9}{Status\+::\+Rest},
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a105b296a83f9c105355403f3332af50f}{Status\+::\+Pause},
|
||||
\newline
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a526d688f37a86d3c3f27d0c5016eb71d}{Status\+::\+Reset},
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481}{Status\+::\+Stop}
|
||||
\}\begin{DoxyCompactList}\small\item\em Define the status of the timer Some statuses are not saved, they are used to activate something. \end{DoxyCompactList}
|
||||
\end{DoxyCompactItemize}
|
||||
\subsection*{Public Slots}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_add8675aed0b0f7f2a90482456c63c8f3}{apply\+Status} ()
|
||||
\begin{DoxyCompactList}\small\item\em Apply status and exec relative functions. \end{DoxyCompactList}\item
|
||||
void \hyperlink{class_boxing_timer_a31cea07043d1be260db69767ccf96871}{update\+Remaining\+Milliseconds} ()
|
||||
\begin{DoxyCompactList}\small\item\em Switch milliseconds from round to rest and back. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
\subsection*{Signals}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_a3ef71d6ec54505732d9d5b96c5af1747}{remaining\+Time\+To\+String\+Changed} ()
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_a2c8d9c3c9916fc1ed65fb9545565835f}{rounds\+To\+String\+Changed} ()
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}{status\+Changed} ()
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_a96dae97c68363403d732d74461d01499}{preset\+Changed} ()
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_a4f2001335cd6249a350d87708b785de5}{active\+Changed} ()
|
||||
\end{DoxyCompactItemize}
|
||||
\subsection*{Public Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE void \hyperlink{class_boxing_timer_a34f9e66cbe5bead806037a7ce882da4d}{restore} ()
|
||||
\begin{DoxyCompactList}\small\item\em Start or restore the timer. \end{DoxyCompactList}\item
|
||||
Q\+\_\+\+I\+N\+V\+O\+K\+A\+B\+LE void \hyperlink{class_boxing_timer_af8e0f0d2a34946e0a20562bfb187adbe}{load\+Preset} (const Q\+String \&preset)
|
||||
\begin{DoxyCompactList}\small\item\em Load the preset to change settings of timer. \end{DoxyCompactList}\item
|
||||
\hyperlink{class_boxing_timer_ad5a57c7272222f91a75363bdad6543ba}{Boxing\+Timer} ()
|
||||
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item
|
||||
const Q\+String \hyperlink{class_boxing_timer_a808ea8addb66a3a6f9270e56ed2518cf}{rounds\+To\+String} ()
|
||||
\begin{DoxyCompactList}\small\item\em Convert round and total rounds for view. \end{DoxyCompactList}\item
|
||||
const Q\+String \hyperlink{class_boxing_timer_adddbecef36c86e650439141a7bf22ea4}{remaining\+Time\+To\+String} ()
|
||||
\begin{DoxyCompactList}\small\item\em Convert remaining milliseconds in human readable time. \end{DoxyCompactList}\item
|
||||
\hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Status} \hyperlink{class_boxing_timer_a091d7fb11525455766c19d6b9c250fa4}{get\+Status} ()
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_aa097f85ad7fd3602cc2583c3cc6c4d5e}{set\+Status} (const \hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Status} \&status)
|
||||
\item
|
||||
const Q\+String \hyperlink{class_boxing_timer_aae9b18b16d38e1dd98a33ff0d0bed959}{get\+Preset} ()
|
||||
\end{DoxyCompactItemize}
|
||||
\subsection*{Protected Member Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
void \hyperlink{class_boxing_timer_aa294afc288608f91eb00d1680db67738}{stop} ()
|
||||
\begin{DoxyCompactList}\small\item\em Override of stop function to emit \hyperlink{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}{status\+Changed()} signal. \end{DoxyCompactList}\item
|
||||
void \hyperlink{class_boxing_timer_a64ae1d3a8bfe52b225658bf4121dcdfa}{start} (const int \&milliseconds)
|
||||
\begin{DoxyCompactList}\small\item\em Override of start function to emit \hyperlink{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}{status\+Changed()} signal. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\subsection{Detailed Description}
|
||||
Boxing timer class.
|
||||
|
||||
\begin{DoxyAuthor}{Author}
|
||||
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
||||
\end{DoxyAuthor}
|
||||
Inherit Q\+Timer class and add some properties to handle rest and rounds for training
|
||||
|
||||
\subsection{Member Enumeration Documentation}
|
||||
\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!Status@{Status}}
|
||||
\index{Status@{Status}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{Status}{Status}}
|
||||
{\footnotesize\ttfamily enum \hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Boxing\+Timer\+::\+Status} \+: short\hspace{0.3cm}{\ttfamily [strong]}}
|
||||
|
||||
|
||||
|
||||
Define the status of the timer Some statuses are not saved, they are used to activate something.
|
||||
|
||||
\begin{DoxyEnumFields}{Enumerator}
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Default@{Default}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Default@{Default}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a7a1920d61156abc05a60135aefe8bc67}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a7a1920d61156abc05a60135aefe8bc67}}
|
||||
Default&\\
|
||||
\hline
|
||||
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Start@{Start}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Start@{Start}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558aa6122a65eaa676f700ae68d393054a37}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558aa6122a65eaa676f700ae68d393054a37}}
|
||||
Start&\\
|
||||
\hline
|
||||
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Rest@{Rest}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Rest@{Rest}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a55276c10d84e1df7713b441e76e141f9}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a55276c10d84e1df7713b441e76e141f9}}
|
||||
Rest&\\
|
||||
\hline
|
||||
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Pause@{Pause}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Pause@{Pause}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a105b296a83f9c105355403f3332af50f}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a105b296a83f9c105355403f3332af50f}}
|
||||
Pause&\\
|
||||
\hline
|
||||
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Reset@{Reset}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Reset@{Reset}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a526d688f37a86d3c3f27d0c5016eb71d}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a526d688f37a86d3c3f27d0c5016eb71d}}
|
||||
Reset&\\
|
||||
\hline
|
||||
|
||||
\raisebox{\heightof{T}}[0pt][0pt]{\index{Stop@{Stop}!Boxing\+Timer@{Boxing\+Timer}}\index{Boxing\+Timer@{Boxing\+Timer}!Stop@{Stop}}}\mbox{\Hypertarget{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481}\label{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558a11a755d598c0c417f9a36758c3da7481}}
|
||||
Stop&\\
|
||||
\hline
|
||||
|
||||
\end{DoxyEnumFields}
|
||||
|
||||
|
||||
\subsection{Constructor \& Destructor Documentation}
|
||||
\mbox{\Hypertarget{class_boxing_timer_ad5a57c7272222f91a75363bdad6543ba}\label{class_boxing_timer_ad5a57c7272222f91a75363bdad6543ba}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{Boxing\+Timer()}{BoxingTimer()}}
|
||||
{\footnotesize\ttfamily Boxing\+Timer\+::\+Boxing\+Timer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [explicit]}}
|
||||
|
||||
|
||||
|
||||
Default constructor.
|
||||
|
||||
\begin{DoxyAuthor}{Author}
|
||||
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
||||
\end{DoxyAuthor}
|
||||
m\+Round set to 0 with a very coarse timer. Load default settings.
|
||||
|
||||
\subsection{Member Function Documentation}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a4f2001335cd6249a350d87708b785de5}\label{class_boxing_timer_a4f2001335cd6249a350d87708b785de5}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!active\+Changed@{active\+Changed}}
|
||||
\index{active\+Changed@{active\+Changed}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{active\+Changed}{activeChanged}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::active\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_add8675aed0b0f7f2a90482456c63c8f3}\label{class_boxing_timer_add8675aed0b0f7f2a90482456c63c8f3}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!apply\+Status@{apply\+Status}}
|
||||
\index{apply\+Status@{apply\+Status}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{apply\+Status}{applyStatus}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::apply\+Status (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}
|
||||
|
||||
|
||||
|
||||
Apply status and exec relative functions.
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_aae9b18b16d38e1dd98a33ff0d0bed959}\label{class_boxing_timer_aae9b18b16d38e1dd98a33ff0d0bed959}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!get\+Preset@{get\+Preset}}
|
||||
\index{get\+Preset@{get\+Preset}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{get\+Preset()}{getPreset()}}
|
||||
{\footnotesize\ttfamily const Q\+String Boxing\+Timer\+::get\+Preset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
the loaded preset for timer
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a091d7fb11525455766c19d6b9c250fa4}\label{class_boxing_timer_a091d7fb11525455766c19d6b9c250fa4}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!get\+Status@{get\+Status}}
|
||||
\index{get\+Status@{get\+Status}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{get\+Status()}{getStatus()}}
|
||||
{\footnotesize\ttfamily \hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Status} Boxing\+Timer\+::get\+Status (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
||||
|
||||
\begin{DoxyReturn}{Returns}
|
||||
actual status -\/ enum value
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{class_boxing_timer_af8e0f0d2a34946e0a20562bfb187adbe}\label{class_boxing_timer_af8e0f0d2a34946e0a20562bfb187adbe}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!load\+Preset@{load\+Preset}}
|
||||
\index{load\+Preset@{load\+Preset}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{load\+Preset()}{loadPreset()}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::load\+Preset (\begin{DoxyParamCaption}\item[{const Q\+String \&}]{preset }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Load the preset to change settings of timer.
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em preset} & a const Q\+String \\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a96dae97c68363403d732d74461d01499}\label{class_boxing_timer_a96dae97c68363403d732d74461d01499}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!preset\+Changed@{preset\+Changed}}
|
||||
\index{preset\+Changed@{preset\+Changed}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{preset\+Changed}{presetChanged}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::preset\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_adddbecef36c86e650439141a7bf22ea4}\label{class_boxing_timer_adddbecef36c86e650439141a7bf22ea4}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!remaining\+Time\+To\+String@{remaining\+Time\+To\+String}}
|
||||
\index{remaining\+Time\+To\+String@{remaining\+Time\+To\+String}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{remaining\+Time\+To\+String()}{remainingTimeToString()}}
|
||||
{\footnotesize\ttfamily const Q\+String Boxing\+Timer\+::remaining\+Time\+To\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Convert remaining milliseconds in human readable time.
|
||||
|
||||
\begin{DoxyAuthor}{Author}
|
||||
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
||||
\end{DoxyAuthor}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
the remaining time as const Q\+String of remaining milliseconds
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a3ef71d6ec54505732d9d5b96c5af1747}\label{class_boxing_timer_a3ef71d6ec54505732d9d5b96c5af1747}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!remaining\+Time\+To\+String\+Changed@{remaining\+Time\+To\+String\+Changed}}
|
||||
\index{remaining\+Time\+To\+String\+Changed@{remaining\+Time\+To\+String\+Changed}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{remaining\+Time\+To\+String\+Changed}{remainingTimeToStringChanged}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::remaining\+Time\+To\+String\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_a34f9e66cbe5bead806037a7ce882da4d}\label{class_boxing_timer_a34f9e66cbe5bead806037a7ce882da4d}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!restore@{restore}}
|
||||
\index{restore@{restore}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{restore()}{restore()}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::restore (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Start or restore the timer.
|
||||
|
||||
\begin{DoxyAuthor}{Author}
|
||||
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
||||
\end{DoxyAuthor}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a808ea8addb66a3a6f9270e56ed2518cf}\label{class_boxing_timer_a808ea8addb66a3a6f9270e56ed2518cf}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!rounds\+To\+String@{rounds\+To\+String}}
|
||||
\index{rounds\+To\+String@{rounds\+To\+String}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{rounds\+To\+String()}{roundsToString()}}
|
||||
{\footnotesize\ttfamily const Q\+String Boxing\+Timer\+::rounds\+To\+String (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
|
||||
Convert round and total rounds for view.
|
||||
|
||||
\begin{DoxyAuthor}{Author}
|
||||
Claudio Maradonna \href{mailto:claudio@unitoo.pw}{\tt claudio@unitoo.\+pw}
|
||||
\end{DoxyAuthor}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
the number as const Q\+String of actual round and total rounds for Q\+ML
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a2c8d9c3c9916fc1ed65fb9545565835f}\label{class_boxing_timer_a2c8d9c3c9916fc1ed65fb9545565835f}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!rounds\+To\+String\+Changed@{rounds\+To\+String\+Changed}}
|
||||
\index{rounds\+To\+String\+Changed@{rounds\+To\+String\+Changed}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{rounds\+To\+String\+Changed}{roundsToStringChanged}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::rounds\+To\+String\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_aa097f85ad7fd3602cc2583c3cc6c4d5e}\label{class_boxing_timer_aa097f85ad7fd3602cc2583c3cc6c4d5e}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!set\+Status@{set\+Status}}
|
||||
\index{set\+Status@{set\+Status}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{set\+Status()}{setStatus()}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::set\+Status (\begin{DoxyParamCaption}\item[{const \hyperlink{class_boxing_timer_af2a4f0a0658b3685b2e0bcd965dca558}{Status} \&}]{status }\end{DoxyParamCaption})}
|
||||
|
||||
|
||||
\begin{DoxyParams}{Parameters}
|
||||
{\em status} & const Status\\
|
||||
\hline
|
||||
\end{DoxyParams}
|
||||
\begin{DoxyReturn}{Returns}
|
||||
Setter for status
|
||||
\end{DoxyReturn}
|
||||
\mbox{\Hypertarget{class_boxing_timer_a64ae1d3a8bfe52b225658bf4121dcdfa}\label{class_boxing_timer_a64ae1d3a8bfe52b225658bf4121dcdfa}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!start@{start}}
|
||||
\index{start@{start}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{start()}{start()}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::start (\begin{DoxyParamCaption}\item[{const int \&}]{milliseconds }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
|
||||
|
||||
|
||||
Override of start function to emit \hyperlink{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}{status\+Changed()} signal.
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}\label{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!status\+Changed@{status\+Changed}}
|
||||
\index{status\+Changed@{status\+Changed}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{status\+Changed}{statusChanged}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::status\+Changed (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [signal]}}
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_aa294afc288608f91eb00d1680db67738}\label{class_boxing_timer_aa294afc288608f91eb00d1680db67738}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!stop@{stop}}
|
||||
\index{stop@{stop}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{stop()}{stop()}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::stop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}}
|
||||
|
||||
|
||||
|
||||
Override of stop function to emit \hyperlink{class_boxing_timer_ab3d16c454a2fac620bb84721c105485a}{status\+Changed()} signal.
|
||||
|
||||
\mbox{\Hypertarget{class_boxing_timer_a31cea07043d1be260db69767ccf96871}\label{class_boxing_timer_a31cea07043d1be260db69767ccf96871}}
|
||||
\index{Boxing\+Timer@{Boxing\+Timer}!update\+Remaining\+Milliseconds@{update\+Remaining\+Milliseconds}}
|
||||
\index{update\+Remaining\+Milliseconds@{update\+Remaining\+Milliseconds}!Boxing\+Timer@{Boxing\+Timer}}
|
||||
\subsubsection{\texorpdfstring{update\+Remaining\+Milliseconds}{updateRemainingMilliseconds}}
|
||||
{\footnotesize\ttfamily void Boxing\+Timer\+::update\+Remaining\+Milliseconds (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [slot]}}
|
||||
|
||||
|
||||
|
||||
Switch milliseconds from round to rest and back.
|
||||
|
||||
|
||||
|
||||
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
||||
\item
|
||||
src/\hyperlink{boxingtimer_8h}{boxingtimer.\+h}\item
|
||||
src/\hyperlink{boxingtimer_8cpp}{boxingtimer.\+cpp}\end{DoxyCompactItemize}
|
||||
15
documentation/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex
Normal file
15
documentation/latex/dir_68267d1309a1af8e8297ef4c3efbcdba.tex
Normal file
@ -0,0 +1,15 @@
|
||||
\hypertarget{dir_68267d1309a1af8e8297ef4c3efbcdba}{}\section{src Directory Reference}
|
||||
\label{dir_68267d1309a1af8e8297ef4c3efbcdba}\index{src Directory Reference@{src Directory Reference}}
|
||||
\subsection*{Files}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
file \hyperlink{boxingsettings_8cpp}{boxingsettings.\+cpp}
|
||||
\item
|
||||
file \hyperlink{boxingsettings_8h}{boxingsettings.\+h}
|
||||
\item
|
||||
file \hyperlink{boxingtimer_8cpp}{boxingtimer.\+cpp}
|
||||
\item
|
||||
file \hyperlink{boxingtimer_8h}{boxingtimer.\+h}
|
||||
\item
|
||||
file \hyperlink{harbour-boxing-timer_8cpp}{harbour-\/boxing-\/timer.\+cpp}
|
||||
\end{DoxyCompactItemize}
|
||||
503
documentation/latex/doxygen.sty
Normal file
503
documentation/latex/doxygen.sty
Normal file
@ -0,0 +1,503 @@
|
||||
\NeedsTeXFormat{LaTeX2e}
|
||||
\ProvidesPackage{doxygen}
|
||||
|
||||
% Packages used by this style file
|
||||
\RequirePackage{alltt}
|
||||
\RequirePackage{array}
|
||||
\RequirePackage{calc}
|
||||
\RequirePackage{float}
|
||||
\RequirePackage{ifthen}
|
||||
\RequirePackage{verbatim}
|
||||
\RequirePackage[table]{xcolor}
|
||||
\RequirePackage{longtable}
|
||||
\RequirePackage{tabu}
|
||||
\RequirePackage{tabularx}
|
||||
\RequirePackage{multirow}
|
||||
|
||||
%---------- Internal commands used in this style file ----------------
|
||||
|
||||
\newcommand{\ensurespace}[1]{%
|
||||
\begingroup%
|
||||
\setlength{\dimen@}{#1}%
|
||||
\vskip\z@\@plus\dimen@%
|
||||
\penalty -100\vskip\z@\@plus -\dimen@%
|
||||
\vskip\dimen@%
|
||||
\penalty 9999%
|
||||
\vskip -\dimen@%
|
||||
\vskip\z@skip% hide the previous |\vskip| from |\addvspace|
|
||||
\endgroup%
|
||||
}
|
||||
|
||||
\newcommand{\DoxyLabelFont}{}
|
||||
\newcommand{\entrylabel}[1]{%
|
||||
{%
|
||||
\parbox[b]{\labelwidth-4pt}{%
|
||||
\makebox[0pt][l]{\DoxyLabelFont#1}%
|
||||
\vspace{1.5\baselineskip}%
|
||||
}%
|
||||
}%
|
||||
}
|
||||
|
||||
\newenvironment{DoxyDesc}[1]{%
|
||||
\ensurespace{4\baselineskip}%
|
||||
\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}%
|
||||
\item[#1]%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
\newsavebox{\xrefbox}
|
||||
\newlength{\xreflength}
|
||||
\newcommand{\xreflabel}[1]{%
|
||||
\sbox{\xrefbox}{#1}%
|
||||
\setlength{\xreflength}{\wd\xrefbox}%
|
||||
\ifthenelse{\xreflength>\labelwidth}{%
|
||||
\begin{minipage}{\textwidth}%
|
||||
\setlength{\parindent}{0pt}%
|
||||
\hangindent=15pt\bfseries #1\vspace{1.2\itemsep}%
|
||||
\end{minipage}%
|
||||
}{%
|
||||
\parbox[b]{\labelwidth}{\makebox[0pt][l]{\textbf{#1}}}%
|
||||
}%
|
||||
}
|
||||
|
||||
%---------- Commands used by doxygen LaTeX output generator ----------
|
||||
|
||||
% Used by <pre> ... </pre>
|
||||
\newenvironment{DoxyPre}{%
|
||||
\small%
|
||||
\begin{alltt}%
|
||||
}{%
|
||||
\end{alltt}%
|
||||
\normalsize%
|
||||
}
|
||||
|
||||
% Used by @code ... @endcode
|
||||
\newenvironment{DoxyCode}{%
|
||||
\par%
|
||||
\scriptsize%
|
||||
\begin{alltt}%
|
||||
}{%
|
||||
\end{alltt}%
|
||||
\normalsize%
|
||||
}
|
||||
|
||||
% Used by @example, @include, @includelineno and @dontinclude
|
||||
\newenvironment{DoxyCodeInclude}{%
|
||||
\DoxyCode%
|
||||
}{%
|
||||
\endDoxyCode%
|
||||
}
|
||||
|
||||
% Used by @verbatim ... @endverbatim
|
||||
\newenvironment{DoxyVerb}{%
|
||||
\footnotesize%
|
||||
\verbatim%
|
||||
}{%
|
||||
\endverbatim%
|
||||
\normalsize%
|
||||
}
|
||||
|
||||
% Used by @verbinclude
|
||||
\newenvironment{DoxyVerbInclude}{%
|
||||
\DoxyVerb%
|
||||
}{%
|
||||
\endDoxyVerb%
|
||||
}
|
||||
|
||||
% Used by numbered lists (using '-#' or <ol> ... </ol>)
|
||||
\newenvironment{DoxyEnumerate}{%
|
||||
\enumerate%
|
||||
}{%
|
||||
\endenumerate%
|
||||
}
|
||||
|
||||
% Used by bullet lists (using '-', @li, @arg, or <ul> ... </ul>)
|
||||
\newenvironment{DoxyItemize}{%
|
||||
\itemize%
|
||||
}{%
|
||||
\enditemize%
|
||||
}
|
||||
|
||||
% Used by description lists (using <dl> ... </dl>)
|
||||
\newenvironment{DoxyDescription}{%
|
||||
\description%
|
||||
}{%
|
||||
\enddescription%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if caption is specified)
|
||||
\newenvironment{DoxyImage}{%
|
||||
\begin{figure}[H]%
|
||||
\begin{center}%
|
||||
}{%
|
||||
\end{center}%
|
||||
\end{figure}%
|
||||
}
|
||||
|
||||
% Used by @image, @dotfile, @dot ... @enddot, and @msc ... @endmsc
|
||||
% (only if no caption is specified)
|
||||
\newenvironment{DoxyImageNoCaption}{%
|
||||
\begin{center}%
|
||||
}{%
|
||||
\end{center}%
|
||||
}
|
||||
|
||||
% Used by @attention
|
||||
\newenvironment{DoxyAttention}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @author and @authors
|
||||
\newenvironment{DoxyAuthor}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @date
|
||||
\newenvironment{DoxyDate}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @invariant
|
||||
\newenvironment{DoxyInvariant}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @note
|
||||
\newenvironment{DoxyNote}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @post
|
||||
\newenvironment{DoxyPostcond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @pre
|
||||
\newenvironment{DoxyPrecond}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @copyright
|
||||
\newenvironment{DoxyCopyright}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @remark
|
||||
\newenvironment{DoxyRemark}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @return and @returns
|
||||
\newenvironment{DoxyReturn}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @since
|
||||
\newenvironment{DoxySince}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @see
|
||||
\newenvironment{DoxySeeAlso}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @version
|
||||
\newenvironment{DoxyVersion}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @warning
|
||||
\newenvironment{DoxyWarning}[1]{%
|
||||
\begin{DoxyDesc}{#1}%
|
||||
}{%
|
||||
\end{DoxyDesc}%
|
||||
}
|
||||
|
||||
% Used by @internal
|
||||
\newenvironment{DoxyInternal}[1]{%
|
||||
\paragraph*{#1}%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by @par and @paragraph
|
||||
\newenvironment{DoxyParagraph}[1]{%
|
||||
\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{40pt}%
|
||||
\setlength{\leftmargin}{\labelwidth}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{-4pt}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}%
|
||||
\item[#1]%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by parameter lists
|
||||
\newenvironment{DoxyParams}[2][]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\ifthenelse{\equal{#1}{}}%
|
||||
{\begin{longtabu} spread 0pt [l]{|X[-1,l]|X[-1,l]|}}% name + description
|
||||
{\ifthenelse{\equal{#1}{1}}%
|
||||
{\begin{longtabu} spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + name + desc
|
||||
{\begin{longtabu} spread 0pt [l]{|X[-1,l]|X[-1,l]|X[-1,l]|X[-1,l]|}}% in/out + type + name + desc
|
||||
}
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #2}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields of simple structs
|
||||
\newenvironment{DoxyFields}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu} spread 0pt [l]{|X[-1,r]|X[-1,l]|X[-1,l]|}%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{3}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for fields simple class style enums
|
||||
\newenvironment{DoxyEnumFields}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu} spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for parameters within a detailed function description
|
||||
\newenvironment{DoxyParamCaption}{%
|
||||
\renewcommand{\item}[2][]{\\ \hspace*{2.0cm} ##1 {\em ##2}}%
|
||||
}{%
|
||||
}
|
||||
|
||||
% Used by return value lists
|
||||
\newenvironment{DoxyRetVals}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu} spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by exception lists
|
||||
\newenvironment{DoxyExceptions}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu} spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used by template parameter lists
|
||||
\newenvironment{DoxyTemplParams}[1]{%
|
||||
\tabulinesep=1mm%
|
||||
\par%
|
||||
\begin{longtabu} spread 0pt [l]{|X[-1,r]|X[-1,l]|}%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endfirsthead%
|
||||
\multicolumn{2}{l}{\hspace{-6pt}\bfseries\fontseries{bc}\selectfont\color{darkgray} #1}\\[1ex]%
|
||||
\hline%
|
||||
\endhead%
|
||||
}{%
|
||||
\end{longtabu}%
|
||||
\vspace{6pt}%
|
||||
}
|
||||
|
||||
% Used for member lists
|
||||
\newenvironment{DoxyCompactItemize}{%
|
||||
\begin{itemize}%
|
||||
\setlength{\itemsep}{-3pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\setlength{\partopsep}{0pt}%
|
||||
}{%
|
||||
\end{itemize}%
|
||||
}
|
||||
|
||||
% Used for member descriptions
|
||||
\newenvironment{DoxyCompactList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\topsep}{0pt}%
|
||||
\renewcommand{\makelabel}{\hfill}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used for reference lists (@bug, @deprecated, @todo, etc.)
|
||||
\newenvironment{DoxyRefList}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\labelwidth}{10pt}%
|
||||
\setlength{\leftmargin}{\labelwidth}%
|
||||
\addtolength{\leftmargin}{\labelsep}%
|
||||
\renewcommand{\makelabel}{\xreflabel}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by @bug, @deprecated, @todo, etc.
|
||||
\newenvironment{DoxyRefDesc}[1]{%
|
||||
\begin{list}{}{%
|
||||
\renewcommand\makelabel[1]{\textbf{##1}}%
|
||||
\settowidth\labelwidth{\makelabel{#1}}%
|
||||
\setlength\leftmargin{\labelwidth+\labelsep}%
|
||||
}%
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by parameter lists and simple sections
|
||||
\newenvironment{Desc}
|
||||
{\begin{list}{}{%
|
||||
\settowidth{\labelwidth}{20pt}%
|
||||
\setlength{\parsep}{0pt}%
|
||||
\setlength{\itemsep}{0pt}%
|
||||
\setlength{\leftmargin}{\labelwidth+\labelsep}%
|
||||
\renewcommand{\makelabel}{\entrylabel}%
|
||||
}
|
||||
}{%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used by tables
|
||||
\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}%
|
||||
\newenvironment{TabularC}[1]%
|
||||
{\tabulinesep=1mm
|
||||
\begin{longtabu} spread 0pt [c]{*#1{|X[-1]}|}}%
|
||||
{\end{longtabu}\par}%
|
||||
|
||||
\newenvironment{TabularNC}[1]%
|
||||
{\begin{tabu} spread 0pt [l]{*#1{|X[-1]}|}}%
|
||||
{\end{tabu}\par}%
|
||||
|
||||
% Used for member group headers
|
||||
\newenvironment{Indent}{%
|
||||
\begin{list}{}{%
|
||||
\setlength{\leftmargin}{0.5cm}%
|
||||
}%
|
||||
\item[]\ignorespaces%
|
||||
}{%
|
||||
\unskip%
|
||||
\end{list}%
|
||||
}
|
||||
|
||||
% Used when hyperlinks are turned off
|
||||
\newcommand{\doxyref}[3]{%
|
||||
\textbf{#1} (\textnormal{#2}\,\pageref{#3})%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned on
|
||||
\newcommand{\doxytablelink}[2]{%
|
||||
\ref{#1}%
|
||||
}
|
||||
|
||||
% Used to link to a table when hyperlinks are turned off
|
||||
\newcommand{\doxytableref}[3]{%
|
||||
\ref{#3}%
|
||||
}
|
||||
|
||||
% Used by @addindex
|
||||
\newcommand{\lcurly}{\{}
|
||||
\newcommand{\rcurly}{\}}
|
||||
|
||||
% Colors used for syntax highlighting
|
||||
\definecolor{comment}{rgb}{0.5,0.0,0.0}
|
||||
\definecolor{keyword}{rgb}{0.0,0.5,0.0}
|
||||
\definecolor{keywordtype}{rgb}{0.38,0.25,0.125}
|
||||
\definecolor{keywordflow}{rgb}{0.88,0.5,0.0}
|
||||
\definecolor{preprocessor}{rgb}{0.5,0.38,0.125}
|
||||
\definecolor{stringliteral}{rgb}{0.0,0.125,0.25}
|
||||
\definecolor{charliteral}{rgb}{0.0,0.5,0.5}
|
||||
\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0}
|
||||
\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43}
|
||||
\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0}
|
||||
\definecolor{vhdlchar}{rgb}{0.0,0.0,0.0}
|
||||
|
||||
% Color used for table heading
|
||||
\newcommand{\tableheadbgcolor}{lightgray}%
|
||||
|
||||
% Version of hypertarget with correct landing location
|
||||
\newcommand{\Hypertarget}[1]{\Hy@raisedlink{\hypertarget{#1}{}}}
|
||||
|
||||
% Define caption that is also suitable in a table
|
||||
\makeatletter
|
||||
\def\doxyfigcaption{%
|
||||
\refstepcounter{figure}%
|
||||
\@dblarg{\@caption{figure}}}
|
||||
\makeatother
|
||||
8
documentation/latex/files.tex
Normal file
8
documentation/latex/files.tex
Normal file
@ -0,0 +1,8 @@
|
||||
\section{File List}
|
||||
Here is a list of all files with brief descriptions\+:\begin{DoxyCompactList}
|
||||
\item\contentsline{section}{src/\hyperlink{boxingsettings_8cpp}{boxingsettings.\+cpp} }{\pageref{boxingsettings_8cpp}}{}
|
||||
\item\contentsline{section}{src/\hyperlink{boxingsettings_8h}{boxingsettings.\+h} }{\pageref{boxingsettings_8h}}{}
|
||||
\item\contentsline{section}{src/\hyperlink{boxingtimer_8cpp}{boxingtimer.\+cpp} }{\pageref{boxingtimer_8cpp}}{}
|
||||
\item\contentsline{section}{src/\hyperlink{boxingtimer_8h}{boxingtimer.\+h} }{\pageref{boxingtimer_8h}}{}
|
||||
\item\contentsline{section}{src/\hyperlink{harbour-boxing-timer_8cpp}{harbour-\/boxing-\/timer.\+cpp} }{\pageref{harbour-boxing-timer_8cpp}}{}
|
||||
\end{DoxyCompactList}
|
||||
2
documentation/latex/group___q_m_l.tex
Normal file
2
documentation/latex/group___q_m_l.tex
Normal file
@ -0,0 +1,2 @@
|
||||
\hypertarget{group___q_m_l}{}\section{What interacts with view}
|
||||
\label{group___q_m_l}\index{What interacts with view@{What interacts with view}}
|
||||
20
documentation/latex/harbour-boxing-timer_8cpp.tex
Normal file
20
documentation/latex/harbour-boxing-timer_8cpp.tex
Normal file
@ -0,0 +1,20 @@
|
||||
\hypertarget{harbour-boxing-timer_8cpp}{}\section{src/harbour-\/boxing-\/timer.cpp File Reference}
|
||||
\label{harbour-boxing-timer_8cpp}\index{src/harbour-\/boxing-\/timer.\+cpp@{src/harbour-\/boxing-\/timer.\+cpp}}
|
||||
{\ttfamily \#include $<$Qt\+Quick$>$}\newline
|
||||
{\ttfamily \#include $<$sailfishapp.\+h$>$}\newline
|
||||
{\ttfamily \#include \char`\"{}boxingtimer.\+h\char`\"{}}\newline
|
||||
{\ttfamily \#include \char`\"{}boxingsettings.\+h\char`\"{}}\newline
|
||||
\subsection*{Functions}
|
||||
\begin{DoxyCompactItemize}
|
||||
\item
|
||||
int \hyperlink{harbour-boxing-timer_8cpp_a0ddf1224851353fc92bfbff6f499fa97}{main} (int argc, char $\ast$argv\mbox{[}$\,$\mbox{]})
|
||||
\end{DoxyCompactItemize}
|
||||
|
||||
|
||||
\subsection{Function Documentation}
|
||||
\mbox{\Hypertarget{harbour-boxing-timer_8cpp_a0ddf1224851353fc92bfbff6f499fa97}\label{harbour-boxing-timer_8cpp_a0ddf1224851353fc92bfbff6f499fa97}}
|
||||
\index{harbour-\/boxing-\/timer.\+cpp@{harbour-\/boxing-\/timer.\+cpp}!main@{main}}
|
||||
\index{main@{main}!harbour-\/boxing-\/timer.\+cpp@{harbour-\/boxing-\/timer.\+cpp}}
|
||||
\subsubsection{\texorpdfstring{main()}{main()}}
|
||||
{\footnotesize\ttfamily int main (\begin{DoxyParamCaption}\item[{int}]{argc, }\item[{char $\ast$}]{argv\mbox{[}$\,$\mbox{]} }\end{DoxyParamCaption})}
|
||||
|
||||
9
documentation/latex/hierarchy.tex
Normal file
9
documentation/latex/hierarchy.tex
Normal file
@ -0,0 +1,9 @@
|
||||
\section{Class Hierarchy}
|
||||
This inheritance list is sorted roughly, but not completely, alphabetically\+:\begin{DoxyCompactList}
|
||||
\item Q\+Settings\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{Boxing\+Settings}{\pageref{class_boxing_settings}}{}
|
||||
\end{DoxyCompactList}
|
||||
\item Q\+Timer\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{Boxing\+Timer}{\pageref{class_boxing_timer}}{}
|
||||
\end{DoxyCompactList}
|
||||
\end{DoxyCompactList}
|
||||
4
documentation/latex/modules.tex
Normal file
4
documentation/latex/modules.tex
Normal file
@ -0,0 +1,4 @@
|
||||
\section{Modules}
|
||||
Here is a list of all modules\+:\begin{DoxyCompactList}
|
||||
\item \contentsline{section}{What interacts with view}{\pageref{group___q_m_l}}{}
|
||||
\end{DoxyCompactList}
|
||||
170
documentation/latex/refman.tex
Normal file
170
documentation/latex/refman.tex
Normal file
@ -0,0 +1,170 @@
|
||||
\documentclass[twoside]{book}
|
||||
|
||||
% Packages required by doxygen
|
||||
\usepackage{fixltx2e}
|
||||
\usepackage{calc}
|
||||
\usepackage{doxygen}
|
||||
\usepackage[export]{adjustbox} % also loads graphicx
|
||||
\usepackage{graphicx}
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage{makeidx}
|
||||
\usepackage{multicol}
|
||||
\usepackage{multirow}
|
||||
\PassOptionsToPackage{warn}{textcomp}
|
||||
\usepackage{textcomp}
|
||||
\usepackage[nointegrals]{wasysym}
|
||||
\usepackage[table]{xcolor}
|
||||
|
||||
% Font selection
|
||||
\usepackage[T1]{fontenc}
|
||||
\usepackage[scaled=.90]{helvet}
|
||||
\usepackage{courier}
|
||||
\usepackage{amssymb}
|
||||
\usepackage{sectsty}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\allsectionsfont{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\renewcommand{\DoxyLabelFont}{%
|
||||
\fontseries{bc}\selectfont%
|
||||
\color{darkgray}%
|
||||
}
|
||||
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
||||
|
||||
% Page & text layout
|
||||
\usepackage{geometry}
|
||||
\geometry{%
|
||||
a4paper,%
|
||||
top=2.5cm,%
|
||||
bottom=2.5cm,%
|
||||
left=2.5cm,%
|
||||
right=2.5cm%
|
||||
}
|
||||
\tolerance=750
|
||||
\hfuzz=15pt
|
||||
\hbadness=750
|
||||
\setlength{\emergencystretch}{15pt}
|
||||
\setlength{\parindent}{0cm}
|
||||
\setlength{\parskip}{3ex plus 2ex minus 2ex}
|
||||
\makeatletter
|
||||
\renewcommand{\paragraph}{%
|
||||
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@parafont%
|
||||
}%
|
||||
}
|
||||
\renewcommand{\subparagraph}{%
|
||||
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
||||
\normalfont\normalsize\bfseries\SS@subparafont%
|
||||
}%
|
||||
}
|
||||
\makeatother
|
||||
|
||||
% Headers & footers
|
||||
\usepackage{fancyhdr}
|
||||
\pagestyle{fancyplain}
|
||||
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
|
||||
\fancyhead[CE]{\fancyplain{}{}}
|
||||
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
|
||||
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
|
||||
\fancyhead[CO]{\fancyplain{}{}}
|
||||
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
|
||||
\fancyfoot[LE]{\fancyplain{}{}}
|
||||
\fancyfoot[CE]{\fancyplain{}{}}
|
||||
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
|
||||
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
|
||||
\fancyfoot[CO]{\fancyplain{}{}}
|
||||
\fancyfoot[RO]{\fancyplain{}{}}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\chaptermark}[1]{%
|
||||
\markboth{#1}{}%
|
||||
}
|
||||
\renewcommand{\sectionmark}[1]{%
|
||||
\markright{\thesection\ #1}%
|
||||
}
|
||||
|
||||
% Indices & bibliography
|
||||
\usepackage{natbib}
|
||||
\usepackage[titles]{tocloft}
|
||||
\setcounter{tocdepth}{3}
|
||||
\setcounter{secnumdepth}{5}
|
||||
\makeindex
|
||||
|
||||
% Hyperlinks (required, but should be loaded last)
|
||||
\usepackage{ifpdf}
|
||||
\ifpdf
|
||||
\usepackage[pdftex,pagebackref=true]{hyperref}
|
||||
\else
|
||||
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
||||
\fi
|
||||
\hypersetup{%
|
||||
colorlinks=true,%
|
||||
linkcolor=blue,%
|
||||
citecolor=blue,%
|
||||
unicode%
|
||||
}
|
||||
|
||||
% Custom commands
|
||||
\newcommand{\clearemptydoublepage}{%
|
||||
\newpage{\pagestyle{empty}\cleardoublepage}%
|
||||
}
|
||||
|
||||
\usepackage{caption}
|
||||
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
||||
|
||||
%===== C O N T E N T S =====
|
||||
|
||||
\begin{document}
|
||||
|
||||
% Titlepage & ToC
|
||||
\hypersetup{pageanchor=false,
|
||||
bookmarksnumbered=true,
|
||||
pdfencoding=unicode
|
||||
}
|
||||
\pagenumbering{alph}
|
||||
\begin{titlepage}
|
||||
\vspace*{7cm}
|
||||
\begin{center}%
|
||||
{\Large Boxing Timer \\[1ex]\large 1.\+0 }\\
|
||||
\vspace*{1cm}
|
||||
{\large Generated by Doxygen 1.8.13}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{arabic}
|
||||
\hypersetup{pageanchor=true}
|
||||
|
||||
%--- Begin generated contents ---
|
||||
\chapter{Module Index}
|
||||
\input{modules}
|
||||
\chapter{Hierarchical Index}
|
||||
\input{hierarchy}
|
||||
\chapter{Class Index}
|
||||
\input{annotated}
|
||||
\chapter{File Index}
|
||||
\input{files}
|
||||
\chapter{Module Documentation}
|
||||
\input{group___q_m_l}
|
||||
\chapter{Class Documentation}
|
||||
\input{class_boxing_settings}
|
||||
\input{class_boxing_timer}
|
||||
\chapter{File Documentation}
|
||||
\input{boxingsettings_8cpp}
|
||||
\input{boxingsettings_8h}
|
||||
\input{boxingtimer_8cpp}
|
||||
\input{boxingtimer_8h}
|
||||
\input{harbour-boxing-timer_8cpp}
|
||||
%--- End generated contents ---
|
||||
|
||||
% Index
|
||||
\backmatter
|
||||
\newpage
|
||||
\phantomsection
|
||||
\clearemptydoublepage
|
||||
\addcontentsline{toc}{chapter}{Index}
|
||||
\printindex
|
||||
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user