Remade Doxygen Docs

This commit is contained in:
2019-12-19 13:50:50 +01:00
parent a3c19e9851
commit ce32ea9a19
214 changed files with 4062 additions and 2226 deletions

View File

@@ -94,6 +94,9 @@ $(document).ready(function(){initNavTree('class_intelli_tool_rectangle.html','')
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_intelli_tool_rectangle.html" title="The IntelliToolRectangle class represents a tool to draw a rectangle.">IntelliToolRectangle</a> class represents a tool to draw a rectangle.
<a href="class_intelli_tool_rectangle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_intelli_tool_rectangle_8h_source.html">IntelliToolRectangle.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IntelliToolRectangle:</div>
@@ -109,26 +112,28 @@ Collaboration diagram for IntelliToolRectangle:</div>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9823939a8b8924520a2943cf6335c11"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#aa9823939a8b8924520a2943cf6335c11">IntelliToolRectangle</a> (<a class="el" href="class_painting_area.html">PaintingArea</a> *<a class="el" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="el" href="class_intelli_color_picker.html">IntelliColorPicker</a> *<a class="el" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>)</td></tr>
<tr class="memdesc:aa9823939a8b8924520a2943cf6335c11"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor setting the general paintingArea and colorPicker. And reading in the alphaInner and edgeWidth. <a href="class_intelli_tool_rectangle.html#aa9823939a8b8924520a2943cf6335c11">More...</a><br /></td></tr>
<tr class="separator:aa9823939a8b8924520a2943cf6335c11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dc1463e726a21255e6297241dc71fb1"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#a7dc1463e726a21255e6297241dc71fb1">~IntelliToolRectangle</a> () override</td></tr>
<tr class="memdesc:a7dc1463e726a21255e6297241dc71fb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Destructor. <a href="class_intelli_tool_rectangle.html#a7dc1463e726a21255e6297241dc71fb1">More...</a><br /></td></tr>
<tr class="separator:a7dc1463e726a21255e6297241dc71fb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a480c6804a4963c5a1c3f7ef84b63c1a8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">onMouseRightPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:a480c6804a4963c5a1c3f7ef84b63c1a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click Pressed of a Mouse. Constructing the Canvas to draw on. Call this in child classes! <a href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">More...</a><br /></td></tr>
<tr class="memdesc:a480c6804a4963c5a1c3f7ef84b63c1a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click pressed of a mouse.Resetting the current draw. <a href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">More...</a><br /></td></tr>
<tr class="separator:a480c6804a4963c5a1c3f7ef84b63c1a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad43f653256a6516b9398f82054be0d7f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">onMouseRightReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:ad43f653256a6516b9398f82054be0d7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click Released of a Mouse. Merging the Canvas to Active. Call this in child classes! <a href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">More...</a><br /></td></tr>
<tr class="memdesc:ad43f653256a6516b9398f82054be0d7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click released of a mouse. <a href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">More...</a><br /></td></tr>
<tr class="separator:ad43f653256a6516b9398f82054be0d7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae03c307ccf66cbe3fd59e3657712368d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">onMouseLeftPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:ae03c307ccf66cbe3fd59e3657712368d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click Pressed of a Mouse. Resetting the current draw. Call this in child classes! <a href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">More...</a><br /></td></tr>
<tr class="memdesc:ae03c307ccf66cbe3fd59e3657712368d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click pressed of a mouse. Setting the originCorner and draws a rectangle. <a href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">More...</a><br /></td></tr>
<tr class="separator:ae03c307ccf66cbe3fd59e3657712368d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94460e3ff1c19e80bde922c55f53cc43"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">onMouseLeftReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:a94460e3ff1c19e80bde922c55f53cc43"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click Released of a Mouse. Call this in child classes! <a href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">More...</a><br /></td></tr>
<tr class="memdesc:a94460e3ff1c19e80bde922c55f53cc43"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click released of a mouse. Merging the draw to the active layer. <a href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">More...</a><br /></td></tr>
<tr class="separator:a94460e3ff1c19e80bde922c55f53cc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a445c53a56e859f970e59f5036e221e0c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">onWheelScrolled</a> (int value) override</td></tr>
<tr class="memdesc:a445c53a56e859f970e59f5036e221e0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the scroll event. A Positive Value means scrolling outwards. Call this in child classes! <a href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">More...</a><br /></td></tr>
<tr class="memdesc:a445c53a56e859f970e59f5036e221e0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the scroll event.Changing edgeWidth relativ to value. <a href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">More...</a><br /></td></tr>
<tr class="separator:a445c53a56e859f970e59f5036e221e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b5931071e21eb6949ffe357315e408b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">onMouseMoved</a> (int x, int y) override</td></tr>
<tr class="memdesc:a4b5931071e21eb6949ffe357315e408b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the mouse moved event. Call this in child classes! <a href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">More...</a><br /></td></tr>
<tr class="memdesc:a4b5931071e21eb6949ffe357315e408b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the mouse moved event.Drawing a rectangle to currrent mouse position. <a href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">More...</a><br /></td></tr>
<tr class="separator:a4b5931071e21eb6949ffe357315e408b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_intelli_tool"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_intelli_tool')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_intelli_tool.html">IntelliTool</a></td></tr>
<tr class="memitem:a346dd55d489fced38e7bb46f9168af91 inherit pub_methods_class_intelli_tool"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#a346dd55d489fced38e7bb46f9168af91">IntelliTool</a> (<a class="el" href="class_painting_area.html">PaintingArea</a> *<a class="el" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a>, <a class="el" href="class_intelli_color_picker.html">IntelliColorPicker</a> *<a class="el" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a>)</td></tr>
@@ -158,8 +163,9 @@ Additional Inherited Members</h2></td></tr>
<tr class="separator:af256de16e9825922d20a23d11617b51b inherit pro_attribs_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_intelli_tool_rectangle_8h_source.html#l00009">9</a> of file <a class="el" href="_intelli_tool_rectangle_8h_source.html">IntelliToolRectangle.h</a>.</p>
<div class="textblock"><p>The <a class="el" href="class_intelli_tool_rectangle.html" title="The IntelliToolRectangle class represents a tool to draw a rectangle.">IntelliToolRectangle</a> class represents a tool to draw a rectangle. </p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_rectangle_8h_source.html#l00011">11</a> of file <a class="el" href="_intelli_tool_rectangle_8h_source.html">IntelliToolRectangle.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa9823939a8b8924520a2943cf6335c11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9823939a8b8924520a2943cf6335c11">&#9670;&nbsp;</a></span>IntelliToolRectangle()</h2>
@@ -187,6 +193,15 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A constructor setting the general paintingArea and colorPicker. And reading in the alphaInner and edgeWidth. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Area</td><td>- The general paintingArea used by the project. </td></tr>
<tr><td class="paramname">colorPicker</td><td>- The general colorPicker used by the project. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_rectangle_8cpp_source.html#l00005">5</a> of file <a class="el" href="_intelli_tool_rectangle_8cpp_source.html">IntelliToolRectangle.cpp</a>.</p>
</div>
@@ -214,6 +229,8 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A Destructor. </p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_rectangle_8cpp_source.html#l00011">11</a> of file <a class="el" href="_intelli_tool_rectangle_8cpp_source.html">IntelliToolRectangle.cpp</a>.</p>
</div>
@@ -253,11 +270,11 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A function managing the left click Pressed of a Mouse. Resetting the current draw. Call this in child classes! </p>
<p>A function managing the left click pressed of a mouse. Setting the originCorner and draws a rectangle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>- The x coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">x</td><td>- The x coordinate relative to the active/canvas layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the active/canvas layer. </td></tr>
</table>
</dd>
</dl>
@@ -307,11 +324,11 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>A function managing the left click Released of a Mouse. Call this in child classes! </p>
<p>A function managing the left click released of a mouse. Merging the draw to the active layer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>- The x coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">x</td><td>- The x coordinate relative to the active/canvas layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the active/canvas layer. </td></tr>
</table>
</dd>
</dl>
@@ -361,11 +378,11 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>A function managing the mouse moved event. Call this in child classes! </p>
<p>A function managing the mouse moved event.Drawing a rectangle to currrent mouse position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>- The x coordinate of the new Mouse Position. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate of the new Mouse Position. </td></tr>
<tr><td class="paramname">x</td><td>- The x coordinate of the new mouse position. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate of the new mouse position. </td></tr>
</table>
</dd>
</dl>
@@ -415,11 +432,11 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>A function managing the right click Pressed of a Mouse. Constructing the Canvas to draw on. Call this in child classes! </p>
<p>A function managing the right click pressed of a mouse.Resetting the current draw. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>- The x coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">x</td><td>- The x coordinate relative to the active/canvas layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the active/canvas layer. </td></tr>
</table>
</dd>
</dl>
@@ -469,11 +486,11 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>A function managing the right click Released of a Mouse. Merging the Canvas to Active. Call this in child classes! </p>
<p>A function managing the right click released of a mouse. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>- The x coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the Active/Canvas Layer. </td></tr>
<tr><td class="paramname">x</td><td>- The x coordinate relative to the active/canvas layer. </td></tr>
<tr><td class="paramname">y</td><td>- The y coordinate relative to the active/canvas layer. </td></tr>
</table>
</dd>
</dl>
@@ -513,7 +530,7 @@ Here is the call graph for this function:</div>
</table>
</div><div class="memdoc">
<p>A function managing the scroll event. A Positive Value means scrolling outwards. Call this in child classes! </p>
<p>A function managing the scroll event.Changing edgeWidth relativ to value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>- The absolute the scroll has changed. </td></tr>