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>
@@ -95,22 +95,22 @@ $(document).ready(function(){initNavTree('_intelli_tool_plain_8h_source.html',''
<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="l00009"></a><span class="lineno"><a class="line" href="class_intelli_tool_plain_tool.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_plain_tool.html">IntelliToolPlainTool</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a>{</div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="class_intelli_tool_plain_tool.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_plain_tool.html">IntelliToolPlainTool</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a> {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="class_intelli_tool_plain_tool.html#a0ff0b9f7b78b763683076e4417236859">IntelliToolPlainTool</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="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_plain_tool.html#a91fe568be05c075814d67440472bb658">~IntelliToolPlainTool</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<a class="code" href="class_intelli_tool_plain_tool.html#a0ff0b9f7b78b763683076e4417236859">IntelliToolPlainTool</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="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_plain_tool.html#a91fe568be05c075814d67440472bb658">~IntelliToolPlainTool</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">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="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">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="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">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="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">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="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">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="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">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="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">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="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">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="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">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="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">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="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
@@ -122,15 +122,15 @@ $(document).ready(function(){initNavTree('_intelli_tool_plain_8h_source.html',''
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_ac23f5d0f07e42fd7c2ea3fc1347da400"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">IntelliToolPlainTool::onMouseLeftReleased</a></div><div class="ttdeci">virtual void onMouseLeftReleased(int x, int y) override</div><div class="ttdoc">A function managing the left click released of a mouse. Merging the fill to the active layer.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00019">IntelliToolPlain.cpp:19</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_plain_tool_html"><div class="ttname"><a href="class_intelli_tool_plain_tool.html">IntelliToolPlainTool</a></div><div class="ttdoc">The IntelliToolPlainTool class represents a tool to fill the whole canvas with one color.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8h_source.html#l00009">IntelliToolPlain.h:9</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_adc004ea421e2cc0ac39cc7a6b6d43d0d"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">IntelliToolPlainTool::onWheelScrolled</a></div><div class="ttdeci">virtual void onWheelScrolled(int value) override</div><div class="ttdoc">A function managing the scroll event.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00036">IntelliToolPlain.cpp:36</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_adc004ea421e2cc0ac39cc7a6b6d43d0d"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">IntelliToolPlainTool::onWheelScrolled</a></div><div class="ttdeci">virtual void onWheelScrolled(int value) override</div><div class="ttdoc">A function managing the scroll event.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00035">IntelliToolPlain.cpp:35</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_a2ae458f1b04eb77a47f6dca5e91e33b8"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">IntelliToolPlainTool::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_plain_8cpp_source.html#l00027">IntelliToolPlain.cpp:27</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_plain_tool_html_a0ff0b9f7b78b763683076e4417236859"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#a0ff0b9f7b78b763683076e4417236859">IntelliToolPlainTool::IntelliToolPlainTool</a></div><div class="ttdeci">IntelliToolPlainTool(PaintingArea *Area, IntelliColorPicker *colorPicker)</div><div class="ttdoc">A constructor setting the general paintingArea and colorPicker.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00005">IntelliToolPlain.cpp:5</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_ab786dd5fa80af863246013d43c4b7ac9"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">IntelliToolPlainTool::onMouseLeftPressed</a></div><div class="ttdeci">virtual void onMouseLeftPressed(int x, int y) override</div><div class="ttdoc">A function managing the left click pressed of a mouse. Filling the whole canvas.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00013">IntelliToolPlain.cpp:13</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>
<div class="ttc" id="aclass_intelli_color_picker_html"><div class="ttname"><a href="class_intelli_color_picker.html">IntelliColorPicker</a></div><div class="ttdoc">The IntelliColorPicker manages the selected colors for one whole project.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_color_picker_8h_source.html#l00011">IntelliColorPicker.h:11</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_acb0c46e16d2c09370a2244a936de38b1"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">IntelliToolPlainTool::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 fill.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00023">IntelliToolPlain.cpp:23</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_ad7546a6335bb3bb4cbf0e1883788d41c"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">IntelliToolPlainTool::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.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00032">IntelliToolPlain.cpp:32</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_acb0c46e16d2c09370a2244a936de38b1"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">IntelliToolPlainTool::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 fill.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00023">IntelliToolPlain.cpp:23</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_ad7546a6335bb3bb4cbf0e1883788d41c"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">IntelliToolPlainTool::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.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00031">IntelliToolPlain.cpp:31</a></div></div>
<div class="ttc" id="aclass_intelli_tool_plain_tool_html_a91fe568be05c075814d67440472bb658"><div class="ttname"><a href="class_intelli_tool_plain_tool.html#a91fe568be05c075814d67440472bb658">IntelliToolPlainTool::~IntelliToolPlainTool</a></div><div class="ttdeci">virtual ~IntelliToolPlainTool() override</div><div class="ttdoc">A Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_plain_8cpp_source.html#l00009">IntelliToolPlain.cpp:9</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->