Updated doxygen docs to latest changes

This commit is contained in:
2019-12-19 19:39:08 +01:00
parent 5073312f7a
commit 9c95059b93
239 changed files with 2996 additions and 2508 deletions

View File

@@ -30,7 +30,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IntelliPhoto
&#160;<span id="projectnumber">0.4</span>
&#160;<span id="projectnumber">0.5</span>
</div>
</td>
</tr>
@@ -93,27 +93,27 @@ $(document).ready(function(){initNavTree('_intelli_tool_pen_8h_source.html','');
<a href="_intelli_tool_pen_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef INTELLITOOLPEN_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define INTELLITOOLPEN_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include&quot;<a class="code" href="_intelli_tool_8h.html">IntelliTool.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include&quot;QColor&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include&quot;QPoint&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_intelli_tool_pen.html"> 10</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_pen.html">IntelliToolPen</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>{</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keywordtype">int</span> penWidth;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; QPoint point;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_intelli_tool_8h.html">IntelliTool.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;QColor&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;QPoint&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_intelli_tool_pen.html"> 10</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_pen.html">IntelliToolPen</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keywordtype">int</span> penWidth;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;QPoint point;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="class_intelli_tool_pen.html#a889891b3ae7cdefb881aed2e7fff9b47">IntelliToolPen</a>(<a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="code" href="class_intelli_color_picker.html">IntelliColorPicker</a>* <a class="code" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_pen.html#ac77a025515d0fed6954556fe2b444818">~IntelliToolPen</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<a class="code" href="class_intelli_tool_pen.html#a889891b3ae7cdefb881aed2e7fff9b47">IntelliToolPen</a>(<a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="code" href="class_intelli_color_picker.html">IntelliColorPicker</a>* <a class="code" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_pen.html#ac77a025515d0fed6954556fe2b444818">~IntelliToolPen</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="preprocessor">#endif // INTELLITOOLPEN_H</span></div>
@@ -124,9 +124,9 @@ $(document).ready(function(){initNavTree('_intelli_tool_pen_8h_source.html','');
<div class="ttc" id="aclass_intelli_tool_pen_html_ac77a025515d0fed6954556fe2b444818"><div class="ttname"><a href="class_intelli_tool_pen.html#ac77a025515d0fed6954556fe2b444818">IntelliToolPen::~IntelliToolPen</a></div><div class="ttdeci">virtual ~IntelliToolPen() override</div><div class="ttdoc">A Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00012">IntelliToolPen.cpp:12</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html_ab4c2698a0f9f25fb6639ec760d2d0289"><div class="ttname"><a href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">IntelliTool::Area</a></div><div class="ttdeci">PaintingArea * Area</div><div class="ttdoc">A pointer to the general PaintingArea to interact with.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00033">IntelliTool.h:33</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html_a58d1d636497b630647ce0c4d652737c2"><div class="ttname"><a href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">IntelliToolPen::onMouseMoved</a></div><div class="ttdeci">virtual void onMouseMoved(int x, int y) override</div><div class="ttdoc">A function managing the mouse moved event. To draw the line.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00035">IntelliToolPen.cpp:35</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html_a1751e3864a0d36ef42ca55021cae73ce"><div class="ttname"><a href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">IntelliToolPen::onMouseRightPressed</a></div><div class="ttdeci">virtual void onMouseRightPressed(int x, int y) override</div><div class="ttdoc">A function managing the right click pressed of a mouse.Resetting the current draw.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00016">IntelliToolPen.cpp:16</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html_a1751e3864a0d36ef42ca55021cae73ce"><div class="ttname"><a href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">IntelliToolPen::onMouseRightPressed</a></div><div class="ttdeci">virtual void onMouseRightPressed(int x, int y) override</div><div class="ttdoc">A function managing the right click pressed of a mouse. Resetting the current draw.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00016">IntelliToolPen.cpp:16</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html_abf8562e8cd2da586afdf4d47b3a4ff13"><div class="ttname"><a href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">IntelliToolPen::onMouseRightReleased</a></div><div class="ttdeci">virtual void onMouseRightReleased(int x, int y) override</div><div class="ttdoc">A function managing the right click released of a mouse.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00020">IntelliToolPen.cpp:20</a></div></div>
<div class="ttc" id="aclass_painting_area_html"><div class="ttname"><a href="class_painting_area.html">PaintingArea</a></div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00025">PaintingArea.h:25</a></div></div>
<div class="ttc" id="aclass_painting_area_html"><div class="ttname"><a href="class_painting_area.html">PaintingArea</a></div><div class="ttdoc">The PaintingArea class manages the methods and stores information about the current painting area,...</div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00036">PaintingArea.h:36</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html"><div class="ttname"><a href="class_intelli_tool_pen.html">IntelliToolPen</a></div><div class="ttdoc">The IntelliToolPen class represents a tool to draw a line.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8h_source.html#l00010">IntelliToolPen.h:10</a></div></div>
<div class="ttc" id="aclass_intelli_tool_pen_html_afe3626ddff440ab125f4a2465c45427a"><div class="ttname"><a href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">IntelliToolPen::onWheelScrolled</a></div><div class="ttdeci">virtual void onWheelScrolled(int value) override</div><div class="ttdoc">A function managing the scroll event. Changing penWidth relativ to value.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_pen_8cpp_source.html#l00044">IntelliToolPen.cpp:44</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html"><div class="ttname"><a href="class_intelli_tool.html">IntelliTool</a></div><div class="ttdoc">An abstract class that manages the basic events, like mouse clicks or scrolls events.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00013">IntelliTool.h:13</a></div></div>