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

Remade Doxygen Docs

Browse Source
This commit is contained in:
Conrad
2019-12-19 13:50:50 +01:00
parent a3c19e9851
commit ce32ea9a19
214 changed files with 4062 additions and 2226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
docs/html/class_intelli_tool_pen.html
View File

@@ -94,6 +94,9 @@ $(document).ready(function(){initNavTree('class_intelli_tool_pen.html','');});
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_intelli_tool_pen.html" title="The IntelliToolPen class represents a tool to draw a line.">IntelliToolPen</a> class represents a tool to draw a line.
<a href="class_intelli_tool_pen.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_intelli_tool_pen_8h_source.html">IntelliToolPen.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for IntelliToolPen:</div>
@@ -109,26 +112,28 @@ Collaboration diagram for IntelliToolPen:</div>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a889891b3ae7cdefb881aed2e7fff9b47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#a889891b3ae7cdefb881aed2e7fff9b47">IntelliToolPen</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:a889891b3ae7cdefb881aed2e7fff9b47"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor setting the general paintingArea and colorPicker. Reading the penWidth. <a href="class_intelli_tool_pen.html#a889891b3ae7cdefb881aed2e7fff9b47">More...</a><br /></td></tr>
<tr class="separator:a889891b3ae7cdefb881aed2e7fff9b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac77a025515d0fed6954556fe2b444818"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#ac77a025515d0fed6954556fe2b444818">~IntelliToolPen</a> () override</td></tr>
<tr class="memdesc:ac77a025515d0fed6954556fe2b444818"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Destructor. <a href="class_intelli_tool_pen.html#ac77a025515d0fed6954556fe2b444818">More...</a><br /></td></tr>
<tr class="separator:ac77a025515d0fed6954556fe2b444818"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1751e3864a0d36ef42ca55021cae73ce"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#a1751e3864a0d36ef42ca55021cae73ce">onMouseRightPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:a1751e3864a0d36ef42ca55021cae73ce"><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_pen.html#a1751e3864a0d36ef42ca55021cae73ce">More...</a><br /></td></tr>
<tr class="memdesc:a1751e3864a0d36ef42ca55021cae73ce"><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_pen.html#a1751e3864a0d36ef42ca55021cae73ce">More...</a><br /></td></tr>
<tr class="separator:a1751e3864a0d36ef42ca55021cae73ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf8562e8cd2da586afdf4d47b3a4ff13"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">onMouseRightReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:abf8562e8cd2da586afdf4d47b3a4ff13"><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_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">More...</a><br /></td></tr>
<tr class="memdesc:abf8562e8cd2da586afdf4d47b3a4ff13"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the right click released of a mouse. <a href="class_intelli_tool_pen.html#abf8562e8cd2da586afdf4d47b3a4ff13">More...</a><br /></td></tr>
<tr class="separator:abf8562e8cd2da586afdf4d47b3a4ff13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ff40aef6d38eb55af31a19322429205"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">onMouseLeftPressed</a> (int x, int y) override</td></tr>
<tr class="memdesc:a8ff40aef6d38eb55af31a19322429205"><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_pen.html#a8ff40aef6d38eb55af31a19322429205">More...</a><br /></td></tr>
<tr class="memdesc:a8ff40aef6d38eb55af31a19322429205"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click pressed of a mouse. Starting the drawing procedure. <a href="class_intelli_tool_pen.html#a8ff40aef6d38eb55af31a19322429205">More...</a><br /></td></tr>
<tr class="separator:a8ff40aef6d38eb55af31a19322429205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abda7a22b9766fa4ad254324a53cab94d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">onMouseLeftReleased</a> (int x, int y) override</td></tr>
<tr class="memdesc:abda7a22b9766fa4ad254324a53cab94d"><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_pen.html#abda7a22b9766fa4ad254324a53cab94d">More...</a><br /></td></tr>
<tr class="memdesc:abda7a22b9766fa4ad254324a53cab94d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the left click released of a mouse. Merging the drawing to the active layer. <a href="class_intelli_tool_pen.html#abda7a22b9766fa4ad254324a53cab94d">More...</a><br /></td></tr>
<tr class="separator:abda7a22b9766fa4ad254324a53cab94d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe3626ddff440ab125f4a2465c45427a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">onWheelScrolled</a> (int value) override</td></tr>
<tr class="memdesc:afe3626ddff440ab125f4a2465c45427a"><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_pen.html#afe3626ddff440ab125f4a2465c45427a">More...</a><br /></td></tr>
<tr class="memdesc:afe3626ddff440ab125f4a2465c45427a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the scroll event. Changing penWidth relativ to value. <a href="class_intelli_tool_pen.html#afe3626ddff440ab125f4a2465c45427a">More...</a><br /></td></tr>
<tr class="separator:afe3626ddff440ab125f4a2465c45427a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58d1d636497b630647ce0c4d652737c2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">onMouseMoved</a> (int x, int y) override</td></tr>
<tr class="memdesc:a58d1d636497b630647ce0c4d652737c2"><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_pen.html#a58d1d636497b630647ce0c4d652737c2">More...</a><br /></td></tr>
<tr class="memdesc:a58d1d636497b630647ce0c4d652737c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function managing the mouse moved event. To draw the line. <a href="class_intelli_tool_pen.html#a58d1d636497b630647ce0c4d652737c2">More...</a><br /></td></tr>
<tr class="separator:a58d1d636497b630647ce0c4d652737c2"><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_pen_8h_source.html#l00008">8</a> of file <a class="el" href="_intelli_tool_pen_8h_source.html">IntelliToolPen.h</a>.</p>
<div class="textblock"><p>The <a class="el" href="class_intelli_tool_pen.html" title="The IntelliToolPen class represents a tool to draw a line.">IntelliToolPen</a> class represents a tool to draw a line. </p>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_pen_8h_source.html#l00010">10</a> of file <a class="el" href="_intelli_tool_pen_8h_source.html">IntelliToolPen.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a889891b3ae7cdefb881aed2e7fff9b47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a889891b3ae7cdefb881aed2e7fff9b47">&#9670;&nbsp;</a></span>IntelliToolPen()</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. Reading the penWidth. </p>
<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>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_intelli_tool_pen_8cpp_source.html#l00007">7</a> of file <a class="el" href="_intelli_tool_pen_8cpp_source.html">IntelliToolPen.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_pen_8cpp_source.html#l00012">12</a> of file <a class="el" href="_intelli_tool_pen_8cpp_source.html">IntelliToolPen.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. Starting the drawing procedure. </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 drawing 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. To draw the line. </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 penWidth 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>