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

@@ -131,7 +131,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a906a2575c16c8a33cb2a5197f8d8cc5b"><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.html#a906a2575c16c8a33cb2a5197f8d8cc5b">More...</a><br /></td></tr>
<tr class="separator:a906a2575c16c8a33cb2a5197f8d8cc5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dccfd4460255ccb866f336406a33574"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#a4dccfd4460255ccb866f336406a33574">onWheelScrolled</a> (int value)</td></tr>
<tr class="memdesc:a4dccfd4460255ccb866f336406a33574"><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.html#a4dccfd4460255ccb866f336406a33574">More...</a><br /></td></tr>
<tr class="memdesc:a4dccfd4460255ccb866f336406a33574"><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.html#a4dccfd4460255ccb866f336406a33574">More...</a><br /></td></tr>
<tr class="separator:a4dccfd4460255ccb866f336406a33574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac10e20414cd8855a2f9b103fb6408639"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#ac10e20414cd8855a2f9b103fb6408639">onMouseMoved</a> (int x, int y)</td></tr>
<tr class="memdesc:ac10e20414cd8855a2f9b103fb6408639"><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.html#ac10e20414cd8855a2f9b103fb6408639">More...</a><br /></td></tr>
@@ -190,7 +190,7 @@ Protected Attributes</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Area</td><td>- The general <a class="el" href="class_painting_area.html">PaintingArea</a> used by the project. </td></tr>
<tr><td class="paramname">colorPicker</td><td>- The general colorPicker 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>
@@ -266,13 +266,13 @@ Protected Attributes</h2></td></tr>
<p>A function managing the left click Pressed of a Mouse. Resetting the current draw. Call this in child classes! </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>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a155d676a5f98311217eb095be4759846">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#ae883b8ae833c78a8867e626c600f9639">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a155d676a5f98311217eb095be4759846">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#ae883b8ae833c78a8867e626c600f9639">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#ae03c307ccf66cbe3fd59e3657712368d">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ac85e3cb6233508ff9612833a8d9e3961">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#ad5d3b741be6d0647a9cdc9da2cb8bc3d">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00025">25</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">
@@ -325,13 +325,13 @@ Here is the caller graph for this function:</div>
<p>A function managing the left click Released of a Mouse. Call this in child classes! </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>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#ac93f76ff20a1c111a403b298bab02482">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#ad8e438ec997c57262b5efc2db4cee1a3">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#ac93f76ff20a1c111a403b298bab02482">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#ad8e438ec997c57262b5efc2db4cee1a3">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#a94460e3ff1c19e80bde922c55f53cc43">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a7438ef96c6c36068bce76e2364e8594c">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#a4e1473ff408ae2e11cf6a43f6f575f21">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00032">32</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">
@@ -384,13 +384,13 @@ Here is the caller graph for this function:</div>
<p>A function managing the mouse moved event. Call this in child classes! </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>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#abc6324ef0778823fe7e35aef8ae37f9b">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#a90ee58c5390a86afc75c14ca79b91d7b">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#abc6324ef0778823fe7e35aef8ae37f9b">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#a90ee58c5390a86afc75c14ca79b91d7b">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#a4b5931071e21eb6949ffe357315e408b">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a3cd42cea99bc7583875abcc0c274c668">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#a0e3a1135f04c73c159137ae219a38922">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00041">41</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">
@@ -443,13 +443,13 @@ Here is the caller graph for this function:</div>
<p>A function managing the right click Pressed of a Mouse. Constructing the Canvas to draw on. Call this in child classes! </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>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a6cce59f3017936214b10b47252a898a3">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#a29d7b9ed4960e6fe1f31ff620363e429">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a6cce59f3017936214b10b47252a898a3">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#a29d7b9ed4960e6fe1f31ff620363e429">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#a480c6804a4963c5a1c3f7ef84b63c1a8">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ada0f7154d119102410a55038763a17e4">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#aa36b012b48311c36e7cd6771a5081427">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00014">14</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">
@@ -497,13 +497,13 @@ Here is the caller graph for this function:</div>
<p>A function managing the right click Released of a Mouse. Merging the Canvas to Active. Call this in child classes! </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>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a6214918cba5753f89d97de4559a2b9b2">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#aca07540f2f7ccb3d2c0b84890c1afc4c">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#a6214918cba5753f89d97de4559a2b9b2">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#aca07540f2f7ccb3d2c0b84890c1afc4c">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#ad43f653256a6516b9398f82054be0d7f">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#a39cf49c0ce46f96be3510f0b70c9d892">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#a47cad87cd02b128b02dc929713bd1d1b">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00021">21</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">
@@ -538,7 +538,7 @@ Here is the caller 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. A positive value means scrolling outwards. Call this in child classes! </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>
@@ -546,7 +546,7 @@ Here is the caller graph for this function:</div>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#aaf1d686e1ec43f41b5186ccfd806b125">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_circle.html#ae2d9b0fb6695c184c4cb507a5fb75506">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">IntelliToolFloodFill</a>, and <a class="el" href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">IntelliToolPlainTool</a>.</p>
<p>Reimplemented in <a class="el" href="class_intelli_tool_line.html#aaf1d686e1ec43f41b5186ccfd806b125">IntelliToolLine</a>, <a class="el" href="class_intelli_tool_circle.html#ae2d9b0fb6695c184c4cb507a5fb75506">IntelliToolCircle</a>, <a class="el" href="class_intelli_tool_rectangle.html#a445c53a56e859f970e59f5036e221e0c">IntelliToolRectangle</a>, <a class="el" href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">IntelliToolPen</a>, <a class="el" href="class_intelli_tool_flood_fill.html#ad58cc7c065123beb6b0270f99e99b991">IntelliToolFloodFill</a>, <a class="el" href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">IntelliToolPlainTool</a>, and <a class="el" href="class_intelli_tool_polygon.html#a713103300c9f023d64d9eec5ac05dd17">IntelliToolPolygon</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_8cpp_source.html#l00046">46</a> of file <a class="el" href="_intelli_tool_8cpp_source.html">IntelliTool.cpp</a>.</p>
<div class="dynheader">