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>
@@ -96,43 +96,43 @@ $(document).ready(function(){initNavTree('_intelli_tool_flood_fill_8h_source.htm
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </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; </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_intelli_tool_flood_fill.html"> 10</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_flood_fill.html">IntelliToolFloodFill</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"><a class="line" href="class_intelli_tool_flood_fill.html"> 10</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_intelli_tool_flood_fill.html">IntelliToolFloodFill</a> : <span class="keyword">public</span> <a class="code" href="class_intelli_tool.html">IntelliTool</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="class_intelli_tool_flood_fill.html#a83b51838da304e274bf866cf2fd5407a">IntelliToolFloodFill</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="l00017"></a><span class="lineno"> 17</span>&#160;<a class="code" href="class_intelli_tool_flood_fill.html#a83b51838da304e274bf866cf2fd5407a">IntelliToolFloodFill</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="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_flood_fill.html#a83b1bd8be0cbb32cdf61a9597ec849ba">~IntelliToolFloodFill</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">virtual</span> <a class="code" href="class_intelli_tool_flood_fill.html#a83b1bd8be0cbb32cdf61a9597ec849ba">~IntelliToolFloodFill</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">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="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">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="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">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="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">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="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">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="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">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="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">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="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">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="l00052"></a><span class="lineno"> 52</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_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <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_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">onWheelScrolled</a>(<span class="keywordtype">int</span> value) <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="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">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="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">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="l00065"></a><span class="lineno"> 65</span>&#160;};</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="preprocessor">#endif // INTELLITOOLFLOODFILL_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclass_intelli_tool_html_ae2e0ac394611a361ab4ef2fe55c03fef"><div class="ttname"><a href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">IntelliTool::colorPicker</a></div><div class="ttdeci">IntelliColorPicker * colorPicker</div><div class="ttdoc">A pointer to the IntelliColorPicker of the PaintingArea to interact with, and get the colors.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_8h_source.html#l00038">IntelliTool.h:38</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a39cf49c0ce46f96be3510f0b70c9d892"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00021">IntelliToolFloodFill.cpp:21</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a39cf49c0ce46f96be3510f0b70c9d892"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00020">IntelliToolFloodFill.cpp:20</a></div></div>
<div class="ttc" id="a_intelli_tool_8h_html"><div class="ttname"><a href="_intelli_tool_8h.html">IntelliTool.h</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a7438ef96c6c36068bce76e2364e8594c"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">IntelliToolFloodFill::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.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00066">IntelliToolFloodFill.cpp:66</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_ad58cc7c065123beb6b0270f99e99b991"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00070">IntelliToolFloodFill.cpp:70</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a7438ef96c6c36068bce76e2364e8594c"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">IntelliToolFloodFill::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.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00068">IntelliToolFloodFill.cpp:68</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_ad58cc7c065123beb6b0270f99e99b991"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00072">IntelliToolFloodFill.cpp:72</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_flood_fill_html_ac85e3cb6233508ff9612833a8d9e3961"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">IntelliToolFloodFill::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. Sets the point to flood fill around and does t...</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00025">IntelliToolFloodFill.cpp: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="ttdef"><b>Definition:</b> <a href="_painting_area_8h_source.html#l00025">PaintingArea.h:25</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_ac85e3cb6233508ff9612833a8d9e3961"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">IntelliToolFloodFill::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. Sets the point to flood fill around and does t...</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00024">IntelliToolFloodFill.cpp:24</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_flood_fill_html_a83b1bd8be0cbb32cdf61a9597ec849ba"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a83b1bd8be0cbb32cdf61a9597ec849ba">IntelliToolFloodFill::~IntelliToolFloodFill</a></div><div class="ttdeci">virtual ~IntelliToolFloodFill() override</div><div class="ttdoc">A Destructor.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00012">IntelliToolFloodFill.cpp:12</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a83b51838da304e274bf866cf2fd5407a"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a83b51838da304e274bf866cf2fd5407a">IntelliToolFloodFill::IntelliToolFloodFill</a></div><div class="ttdeci">IntelliToolFloodFill(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_flood_fill_8cpp_source.html#l00008">IntelliToolFloodFill.cpp:8</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a3cd42cea99bc7583875abcc0c274c668"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00075">IntelliToolFloodFill.cpp:75</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_a3cd42cea99bc7583875abcc0c274c668"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">IntelliToolFloodFill::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_flood_fill_8cpp_source.html#l00077">IntelliToolFloodFill.cpp:77</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_flood_fill_html_ada0f7154d119102410a55038763a17e4"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">IntelliToolFloodFill::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. Clearing the canvas.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00017">IntelliToolFloodFill.cpp:17</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html_ada0f7154d119102410a55038763a17e4"><div class="ttname"><a href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">IntelliToolFloodFill::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. Clearing the canvas.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8cpp_source.html#l00016">IntelliToolFloodFill.cpp:16</a></div></div>
<div class="ttc" id="aclass_intelli_tool_flood_fill_html"><div class="ttname"><a href="class_intelli_tool_flood_fill.html">IntelliToolFloodFill</a></div><div class="ttdoc">The IntelliToolFloodFill class represents a tool to flood FIll a certian area.</div><div class="ttdef"><b>Definition:</b> <a href="_intelli_tool_flood_fill_8h_source.html#l00010">IntelliToolFloodFill.h:10</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->