creyD/intelliphoto
1
0
Fork 0
mirror of https://github.com/creyD/intelliphoto.git synced 2026-04-13 03:40:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Conrad
2019-12-19 11:29:26 +01:00
parent 559f229b7b
commit 4d68b6ab0a
356 changed files with 11771 additions and 2723 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
docs/html/class_intelli_tool_plain_tool.html
View File

@@ -110,34 +110,49 @@ Collaboration diagram for IntelliToolPlainTool:</div>
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="separator:a0ff0b9f7b78b763683076e4417236859"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab786dd5fa80af863246013d43c4b7ac9"><td class="memItemLeft" align="right" valign="top">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="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">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="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:acb0c46e16d2c09370a2244a936de38b1"><td class="memItemLeft" align="right" valign="top">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="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="separator:acb0c46e16d2c09370a2244a936de38b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ae458f1b04eb77a47f6dca5e91e33b8"><td class="memItemLeft" align="right" valign="top">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="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="separator:a2ae458f1b04eb77a47f6dca5e91e33b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7546a6335bb3bb4cbf0e1883788d41c"><td class="memItemLeft" align="right" valign="top">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="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="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="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>
<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>
@@ -209,6 +224,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_plain_8cpp_source.html#l00009">9</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
@@ -254,6 +278,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_plain_8cpp_source.html#l00015">15</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
@@ -299,6 +332,15 @@ 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_plain_8cpp_source.html#l00028">28</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
@@ -344,6 +386,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_plain_8cpp_source.html#l00019">19</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
@@ -389,6 +440,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_plain_8cpp_source.html#l00023">23</a> of file <a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a>.</p>
@@ -398,11 +458,54 @@ Here is the call graph for this function:</div>
<div class="center"><img src="class_intelli_tool_plain_tool_a2ae458f1b04eb77a47f6dca5e91e33b8_cgraph.png" border="0" usemap="#class_intelli_tool_plain_tool_a2ae458f1b04eb77a47f6dca5e91e33b8_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="adc004ea421e2cc0ac39cc7a6b6d43d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc004ea421e2cc0ac39cc7a6b6d43d0d">&#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 IntelliToolPlainTool::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_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">
<div class="center"><img src="class_intelli_tool_plain_tool_adc004ea421e2cc0ac39cc7a6b6d43d0d_cgraph.png" border="0" usemap="#class_intelli_tool_plain_tool_adc004ea421e2cc0ac39cc7a6b6d43d0d_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_plain_8h_source.html">IntelliToolPlain.h</a></li>
<li>src/Tool/<a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a></li>
<li>intelliphoto/src/Tool/<a class="el" href="_intelli_tool_plain_8h_source.html">IntelliToolPlain.h</a></li>
<li>intelliphoto/src/Tool/<a class="el" href="_intelli_tool_plain_8cpp_source.html">IntelliToolPlain.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->