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>
@@ -99,40 +99,40 @@ $(document).ready(function(){initNavTree('_intelli_tool_8h_source.html','');});
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">class </span><a class="code" href="struct_layer_object.html">LayerObject</a>;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">class </span><a class="code" href="class_painting_area.html">PaintingArea</a>;</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="class_intelli_tool.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool.html">IntelliTool</a>{</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="class_intelli_tool.html"> 13</a></span>&#160;<span class="keyword">class </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="keyword">private</span>:</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keywordtype">void</span> createToolLayer();</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keywordtype">void</span> createToolLayer();</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">void</span> mergeToolLayer();</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keywordtype">void</span> mergeToolLayer();</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> deleteToolLayer();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keywordtype">void</span> deleteToolLayer();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289"> 33</a></span>&#160; <a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289"> 33</a></span>&#160;<a class="code" href="class_painting_area.html">PaintingArea</a>* <a class="code" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef"> 38</a></span>&#160; <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="l00038"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef"> 38</a></span>&#160;<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="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f"> 43</a></span>&#160; <a class="code" href="struct_layer_object.html">LayerObject</a>* <a class="code" href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f">Active</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f"> 43</a></span>&#160;<a class="code" href="struct_layer_object.html">LayerObject</a>* <a class="code" href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f">Active</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77"> 48</a></span>&#160; <a class="code" href="struct_layer_object.html">LayerObject</a>* <a class="code" href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77">Canvas</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77"> 48</a></span>&#160;<a class="code" href="struct_layer_object.html">LayerObject</a>* <a class="code" href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77">Canvas</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b"> 53</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b">drawing</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b"> 53</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b">drawing</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="class_intelli_tool.html#a346dd55d489fced38e7bb46f9168af91">IntelliTool</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="l00061"></a><span class="lineno"> 61</span>&#160;<a class="code" href="class_intelli_tool.html#a346dd55d489fced38e7bb46f9168af91">IntelliTool</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="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_tool.html#a57fb1b27d364c9e3696eb928b75fa9f2">~IntelliTool</a>() = 0;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_tool.html#a57fb1b27d364c9e3696eb928b75fa9f2">~IntelliTool</a>() = 0;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a1e6aa68ac5f3c2ca02319e5ef3f0c966">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a1e6aa68ac5f3c2ca02319e5ef3f0c966">onMouseRightPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a16189b00307c6d7e89f28198f54404b0">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a16189b00307c6d7e89f28198f54404b0">onMouseRightReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a34b7ef1dde96b94a0ce450a25ae1778c">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a34b7ef1dde96b94a0ce450a25ae1778c">onMouseLeftPressed</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a906a2575c16c8a33cb2a5197f8d8cc5b">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a906a2575c16c8a33cb2a5197f8d8cc5b">onMouseLeftReleased</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a4dccfd4460255ccb866f336406a33574">onWheelScrolled</a>(<span class="keywordtype">int</span> value);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#a4dccfd4460255ccb866f336406a33574">onWheelScrolled</a>(<span class="keywordtype">int</span> value);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#ac10e20414cd8855a2f9b103fb6408639">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool.html#ac10e20414cd8855a2f9b103fb6408639">onMouseMoved</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;};</div>
@@ -145,8 +145,8 @@ $(document).ready(function(){initNavTree('_intelli_tool_8h_source.html','');});
<div class="ttc" id="aclass_intelli_tool_html_a34b7ef1dde96b94a0ce450a25ae1778c"><div class="ttname"><a href="class_intelli_tool.html#a34b7ef1dde96b94a0ce450a25ae1778c">IntelliTool::onMouseLeftPressed</a></div><div class="ttdeci">virtual void onMouseLeftPressed(int x, int y)</div><div class="ttdoc">A function managing the left click Pressed of a Mouse. Resetting the current draw....</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8cpp_source.html#l00025">IntelliTool.cpp:25</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html_a346dd55d489fced38e7bb46f9168af91"><div class="ttname"><a href="class_intelli_tool.html#a346dd55d489fced38e7bb46f9168af91">IntelliTool::IntelliTool</a></div><div class="ttdeci">IntelliTool(PaintingArea *Area, IntelliColorPicker *colorPicker)</div><div class="ttdoc">A constructor setting the general Painting Area and colorPicker.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8cpp_source.html#l00004">IntelliTool.cpp:4</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_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="astruct_layer_object_html"><div class="ttname"><a href="struct_layer_object.html">LayerObject</a></div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00016">PaintingArea.h:16</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="astruct_layer_object_html"><div class="ttname"><a href="struct_layer_object.html">LayerObject</a></div><div class="ttdoc">The LayerObject struct holds all the information needed to construct a layer.</div><div class="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00024">PaintingArea.h:24</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html_a16189b00307c6d7e89f28198f54404b0"><div class="ttname"><a href="class_intelli_tool.html#a16189b00307c6d7e89f28198f54404b0">IntelliTool::onMouseRightReleased</a></div><div class="ttdeci">virtual void onMouseRightReleased(int x, int y)</div><div class="ttdoc">A function managing the right click Released of a Mouse. Merging the Canvas to Active....</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8cpp_source.html#l00021">IntelliTool.cpp:21</a></div></div>
<div class="ttc" id="a_intelli_color_picker_8h_html"><div class="ttname"><a href="_intelli_color_picker_8h.html">IntelliColorPicker.h</a></div></div>
<div class="ttc" id="aclass_intelli_tool_html_a144d469cc03584f501194529a1b53c77"><div class="ttname"><a href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77">IntelliTool::Canvas</a></div><div class="ttdeci">LayerObject * Canvas</div><div class="ttdoc">A pointer to the drawing canvas of the tool, work on this.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00048">IntelliTool.h:48</a></div></div>