Updated docs

This commit is contained in:
2019-12-19 11:29:26 +01:00
parent 559f229b7b
commit 4d68b6ab0a
356 changed files with 11771 additions and 2723 deletions

View File

@@ -113,38 +113,53 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:acb600b0f4e9225ebce2937c2b7abb4c2"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#acb600b0f4e9225ebce2937c2b7abb4c2">~IntelliToolLine</a> () override</td></tr>
<tr class="separator:acb600b0f4e9225ebce2937c2b7abb4c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cce59f3017936214b10b47252a898a3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#a6cce59f3017936214b10b47252a898a3">onMouseRightPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:a6cce59f3017936214b10b47252a898a3"><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_line.html#a6cce59f3017936214b10b47252a898a3">More...</a><br /></td></tr>
<tr class="separator:a6cce59f3017936214b10b47252a898a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6214918cba5753f89d97de4559a2b9b2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#a6214918cba5753f89d97de4559a2b9b2">onMouseRightReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:a6214918cba5753f89d97de4559a2b9b2"><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_line.html#a6214918cba5753f89d97de4559a2b9b2">More...</a><br /></td></tr>
<tr class="separator:a6214918cba5753f89d97de4559a2b9b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a155d676a5f98311217eb095be4759846"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#a155d676a5f98311217eb095be4759846">onMouseLeftPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:a155d676a5f98311217eb095be4759846"><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_line.html#a155d676a5f98311217eb095be4759846">More...</a><br /></td></tr>
<tr class="separator:a155d676a5f98311217eb095be4759846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac93f76ff20a1c111a403b298bab02482"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#ac93f76ff20a1c111a403b298bab02482">onMouseLeftReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:ac93f76ff20a1c111a403b298bab02482"><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_line.html#ac93f76ff20a1c111a403b298bab02482">More...</a><br /></td></tr>
<tr class="separator:ac93f76ff20a1c111a403b298bab02482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf1d686e1ec43f41b5186ccfd806b125"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#aaf1d686e1ec43f41b5186ccfd806b125">onWheelScrolled</a> (int value) override</td></tr>
<tr class="memdesc:aaf1d686e1ec43f41b5186ccfd806b125"><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_line.html#aaf1d686e1ec43f41b5186ccfd806b125">More...</a><br /></td></tr>
<tr class="separator:aaf1d686e1ec43f41b5186ccfd806b125"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc6324ef0778823fe7e35aef8ae37f9b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_line.html#abc6324ef0778823fe7e35aef8ae37f9b">onMouseMoved</a> (int x, int y) override</td></tr>
<tr class="memdesc:abc6324ef0778823fe7e35aef8ae37f9b"><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_line.html#abc6324ef0778823fe7e35aef8ae37f9b">More...</a><br /></td></tr>
<tr class="separator:abc6324ef0778823fe7e35aef8ae37f9b"><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>
<tr class="memdesc:a346dd55d489fced38e7bb46f9168af91 inherit pub_methods_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor setting the general Painting Area and colorPicker. <a href="class_intelli_tool.html#a346dd55d489fced38e7bb46f9168af91">More...</a><br /></td></tr>
<tr class="separator:a346dd55d489fced38e7bb46f9168af91 inherit pub_methods_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57fb1b27d364c9e3696eb928b75fa9f2 inherit pub_methods_class_intelli_tool"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#a57fb1b27d364c9e3696eb928b75fa9f2">~IntelliTool</a> ()=0</td></tr>
<tr class="memdesc:a57fb1b27d364c9e3696eb928b75fa9f2 inherit pub_methods_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">An abstract Destructor. <a href="class_intelli_tool.html#a57fb1b27d364c9e3696eb928b75fa9f2">More...</a><br /></td></tr>
<tr class="separator:a57fb1b27d364c9e3696eb928b75fa9f2 inherit pub_methods_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_class_intelli_tool"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_intelli_tool')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_intelli_tool.html">IntelliTool</a></td></tr>
<tr class="memitem:ab4c2698a0f9f25fb6639ec760d2d0289 inherit pro_attribs_class_intelli_tool"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_painting_area.html">PaintingArea</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">Area</a></td></tr>
<tr class="memdesc:ab4c2698a0f9f25fb6639ec760d2d0289 inherit pro_attribs_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the general <a class="el" href="class_painting_area.html">PaintingArea</a> to interact with. <a href="class_intelli_tool.html#ab4c2698a0f9f25fb6639ec760d2d0289">More...</a><br /></td></tr>
<tr class="separator:ab4c2698a0f9f25fb6639ec760d2d0289 inherit pro_attribs_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2e0ac394611a361ab4ef2fe55c03fef inherit pro_attribs_class_intelli_tool"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_intelli_color_picker.html">IntelliColorPicker</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">colorPicker</a></td></tr>
<tr class="memdesc:ae2e0ac394611a361ab4ef2fe55c03fef inherit pro_attribs_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the <a class="el" href="class_intelli_color_picker.html" title="The IntelliColorPicker manages the selected colors for one whole project.">IntelliColorPicker</a> of the <a class="el" href="class_painting_area.html">PaintingArea</a> to interact with, and get the colors. <a href="class_intelli_tool.html#ae2e0ac394611a361ab4ef2fe55c03fef">More...</a><br /></td></tr>
<tr class="separator:ae2e0ac394611a361ab4ef2fe55c03fef inherit pro_attribs_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13512e95d21a9934ecb36d73b118c25f inherit pro_attribs_class_intelli_tool"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_layer_object.html">LayerObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f">Active</a></td></tr>
<tr class="memdesc:a13512e95d21a9934ecb36d73b118c25f inherit pro_attribs_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the underlying active Layer, do not work on this. This is used for data grabbing or previews. <a href="class_intelli_tool.html#a13512e95d21a9934ecb36d73b118c25f">More...</a><br /></td></tr>
<tr class="separator:a13512e95d21a9934ecb36d73b118c25f inherit pro_attribs_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a144d469cc03584f501194529a1b53c77 inherit pro_attribs_class_intelli_tool"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_layer_object.html">LayerObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77">Canvas</a></td></tr>
<tr class="memdesc:a144d469cc03584f501194529a1b53c77 inherit pro_attribs_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer to the drawing canvas of the tool, work on this. <a href="class_intelli_tool.html#a144d469cc03584f501194529a1b53c77">More...</a><br /></td></tr>
<tr class="separator:a144d469cc03584f501194529a1b53c77 inherit pro_attribs_class_intelli_tool"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af256de16e9825922d20a23d11617b51b inherit pro_attribs_class_intelli_tool"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b">drawing</a> = false</td></tr>
<tr class="memdesc:af256de16e9825922d20a23d11617b51b inherit pro_attribs_class_intelli_tool"><td class="mdescLeft">&#160;</td><td class="mdescRight">A flag checking if the user is currently drawing or not. <a href="class_intelli_tool.html#af256de16e9825922d20a23d11617b51b">More...</a><br /></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_line_8h_source.html#l00013">13</a> of file <a class="el" href="_intelli_tool_line_8h_source.html">IntelliToolLine.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_line_8h_source.html#l00012">12</a> of file <a class="el" href="_intelli_tool_line_8h_source.html">IntelliToolLine.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9b2d4bcd69409a21f6080edfea4ae2a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b2d4bcd69409a21f6080edfea4ae2a2">&#9670;&nbsp;</a></span>IntelliToolLine()</h2>
@@ -238,6 +253,15 @@ 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>
<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>
</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_line_8cpp_source.html#l00026">26</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
@@ -283,6 +307,15 @@ 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>
<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>
</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_line_8cpp_source.html#l00033">33</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
@@ -328,9 +361,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>
<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>
</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_line_8cpp_source.html#l00037">37</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_line_8cpp_source.html#l00045">45</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
@@ -373,6 +415,15 @@ 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>
<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>
</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_line_8cpp_source.html#l00018">18</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
@@ -418,6 +469,15 @@ 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>
<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>
</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_line_8cpp_source.html#l00022">22</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
@@ -427,11 +487,54 @@ Here is the call graph for this function:</div>
<div class="center"><img src="class_intelli_tool_line_a6214918cba5753f89d97de4559a2b9b2_cgraph.png" border="0" usemap="#class_intelli_tool_line_a6214918cba5753f89d97de4559a2b9b2_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="aaf1d686e1ec43f41b5186ccfd806b125"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf1d686e1ec43f41b5186ccfd806b125">&#9670;&nbsp;</a></span>onWheelScrolled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IntelliToolLine::onWheelScrolled </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>value</em></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 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>
</table>
</dd>
</dl>
<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_line_8cpp_source.html#l00037">37</a> of file <a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_intelli_tool_line_aaf1d686e1ec43f41b5186ccfd806b125_cgraph.png" border="0" usemap="#class_intelli_tool_line_aaf1d686e1ec43f41b5186ccfd806b125_cgraph" alt=""/></div>
</div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/Tool/<a class="el" href="_intelli_tool_line_8h_source.html">IntelliToolLine.h</a></li>
<li>src/Tool/<a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a></li>
<li>intelliphoto/src/Tool/<a class="el" href="_intelli_tool_line_8h_source.html">IntelliToolLine.h</a></li>
<li>intelliphoto/src/Tool/<a class="el" href="_intelli_tool_line_8cpp_source.html">IntelliToolLine.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->