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_plain_tool.html',''
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_intelli_tool_plain_tool.html" title="The IntelliToolPlainTool class represents a tool to fill the whole canvas with one color.">IntelliToolPlainTool</a> class represents a tool to fill the whole canvas with one color.
<a href="class_intelli_tool_plain_tool.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_intelli_tool_plain_8h_source.html">IntelliToolPlain.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IntelliToolPlainTool:</div>
@@ -109,24 +112,28 @@ Collaboration diagram for IntelliToolPlainTool:</div>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0ff0b9f7b78b763683076e4417236859"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#a0ff0b9f7b78b763683076e4417236859">IntelliToolPlainTool</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:a0ff0b9f7b78b763683076e4417236859"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor setting the general paintingArea and colorPicker. <a href="class_intelli_tool_plain_tool.html#a0ff0b9f7b78b763683076e4417236859">More...</a><br /></td></tr>
<tr class="separator:a0ff0b9f7b78b763683076e4417236859"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab786dd5fa80af863246013d43c4b7ac9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">onMouseLeftPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:ab786dd5fa80af863246013d43c4b7ac9"><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_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">More...</a><br /></td></tr>
<tr class="separator:ab786dd5fa80af863246013d43c4b7ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23f5d0f07e42fd7c2ea3fc1347da400"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">onMouseLeftReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:ac23f5d0f07e42fd7c2ea3fc1347da400"><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_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">More...</a><br /></td></tr>
<tr class="separator:ac23f5d0f07e42fd7c2ea3fc1347da400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91fe568be05c075814d67440472bb658"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#a91fe568be05c075814d67440472bb658">~IntelliToolPlainTool</a> () override</td></tr>
<tr class="memdesc:a91fe568be05c075814d67440472bb658"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Destructor. <a href="class_intelli_tool_plain_tool.html#a91fe568be05c075814d67440472bb658">More...</a><br /></td></tr>
<tr class="separator:a91fe568be05c075814d67440472bb658"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb0c46e16d2c09370a2244a936de38b1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">onMouseRightPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:acb0c46e16d2c09370a2244a936de38b1"><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_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">More...</a><br /></td></tr>
<tr class="memdesc:acb0c46e16d2c09370a2244a936de38b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click pressed of a mouse.Resetting the current fill. <a href="class_intelli_tool_plain_tool.html#acb0c46e16d2c09370a2244a936de38b1">More...</a><br /></td></tr>
<tr class="separator:acb0c46e16d2c09370a2244a936de38b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ae458f1b04eb77a47f6dca5e91e33b8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">onMouseRightReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:a2ae458f1b04eb77a47f6dca5e91e33b8"><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_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">More...</a><br /></td></tr>
<tr class="memdesc:a2ae458f1b04eb77a47f6dca5e91e33b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click released of a mouse. <a href="class_intelli_tool_plain_tool.html#a2ae458f1b04eb77a47f6dca5e91e33b8">More...</a><br /></td></tr>
<tr class="separator:a2ae458f1b04eb77a47f6dca5e91e33b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab786dd5fa80af863246013d43c4b7ac9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">onMouseLeftPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:ab786dd5fa80af863246013d43c4b7ac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click pressed of a mouse. Filling the whole canvas. <a href="class_intelli_tool_plain_tool.html#ab786dd5fa80af863246013d43c4b7ac9">More...</a><br /></td></tr>
<tr class="separator:ab786dd5fa80af863246013d43c4b7ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23f5d0f07e42fd7c2ea3fc1347da400"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">onMouseLeftReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:ac23f5d0f07e42fd7c2ea3fc1347da400"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click released of a mouse. Merging the fill to the active layer. <a href="class_intelli_tool_plain_tool.html#ac23f5d0f07e42fd7c2ea3fc1347da400">More...</a><br /></td></tr>
<tr class="separator:ac23f5d0f07e42fd7c2ea3fc1347da400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc004ea421e2cc0ac39cc7a6b6d43d0d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">onWheelScrolled</a> (int value) override</td></tr>
<tr class="memdesc:adc004ea421e2cc0ac39cc7a6b6d43d0d"><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_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">More...</a><br /></td></tr>
<tr class="memdesc:adc004ea421e2cc0ac39cc7a6b6d43d0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the scroll event. <a href="class_intelli_tool_plain_tool.html#adc004ea421e2cc0ac39cc7a6b6d43d0d">More...</a><br /></td></tr>
<tr class="separator:adc004ea421e2cc0ac39cc7a6b6d43d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7546a6335bb3bb4cbf0e1883788d41c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">onMouseMoved</a> (int x, int y) override</td></tr>
<tr class="memdesc:ad7546a6335bb3bb4cbf0e1883788d41c"><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_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">More...</a><br /></td></tr>
<tr class="memdesc:ad7546a6335bb3bb4cbf0e1883788d41c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the mouse moved event. <a href="class_intelli_tool_plain_tool.html#ad7546a6335bb3bb4cbf0e1883788d41c">More...</a><br /></td></tr>
<tr class="separator:ad7546a6335bb3bb4cbf0e1883788d41c"><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>
@@ -156,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_plain_8h_source.html#l00007">7</a> of file <a class="el" href="_intelli_tool_plain_8h_source.html">IntelliToolPlain.h</a>.</p>
<div class="textblock"><p>The <a class="el" href="class_intelli_tool_plain_tool.html" title="The IntelliToolPlainTool class represents a tool to fill the whole canvas with one color.">IntelliToolPlainTool</a> class represents a tool to fill the whole canvas with one color. </p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8h_source.html#l00009">9</a> of file <a class="el" href="_intelli_tool_plain_8h_source.html">IntelliToolPlain.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0ff0b9f7b78b763683076e4417236859"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ff0b9f7b78b763683076e4417236859">&#9670;&nbsp;</a></span>IntelliToolPlainTool()</h2>
@@ -185,8 +193,46 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
<p>A constructor setting the general paintingArea and colorPicker. </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_plain_8cpp_source.html#l00005">5</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
</div>
</div>
<a id="a91fe568be05c075814d67440472bb658"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91fe568be05c075814d67440472bb658">&#9670;&nbsp;</a></span>~IntelliToolPlainTool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IntelliToolPlainTool::~IntelliToolPlainTool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A Destructor. </p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00009">9</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -224,18 +270,18 @@ 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. Filling the whole canvas. </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 from <a class="el" href="class_intelli_tool.html#a34b7ef1dde96b94a0ce450a25ae1778c">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00009">9</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00013">13</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -278,18 +324,18 @@ 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 fill 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>
<p>Reimplemented from <a class="el" href="class_intelli_tool.html#a906a2575c16c8a33cb2a5197f8d8cc5b">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00015">15</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00019">19</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -332,18 +378,18 @@ 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. </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 from <a class="el" href="class_intelli_tool.html#ac10e20414cd8855a2f9b103fb6408639">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00028">28</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00032">32</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -386,18 +432,18 @@ 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 fill. </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 from <a class="el" href="class_intelli_tool.html#a1e6aa68ac5f3c2ca02319e5ef3f0c966">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00019">19</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00023">23</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -440,18 +486,18 @@ 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>
<p>Reimplemented from <a class="el" href="class_intelli_tool.html#a16189b00307c6d7e89f28198f54404b0">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00023">23</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00027">27</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -484,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. </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>
@@ -494,7 +540,7 @@ Here is the call graph for this function:</div>
<p>Reimplemented from <a class="el" href="class_intelli_tool.html#a4dccfd4460255ccb866f336406a33574">IntelliTool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00032">32</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_plain_8cpp_source.html#l00036">36</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">