diff -r 8014a543718a -r ce3163531e4b ToolGenerateHash/Documentation/source/Plugin_Tools_GenerateHash.PluginToolGenerateHash.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/ToolGenerateHash/Documentation/source/Plugin_Tools_GenerateHash.PluginToolGenerateHash.html Sat Dec 28 16:30:45 2013 +0100
@@ -0,0 +1,189 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Tools_GenerateHash.PluginToolGenerateHash</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Tools_GenerateHash.PluginToolGenerateHash</h1>
+<p>
+Module implementing the 'Generate Hash' tool plug-in.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#ToolGenerateHashPlugin">ToolGenerateHashPlugin</a></td>
+<td>Class implementing the 'Generate Hash' tool plug-in.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="ToolGenerateHashPlugin" ID="ToolGenerateHashPlugin"></a>
+<h2>ToolGenerateHashPlugin</h2>
+<p>
+ Class implementing the 'Generate Hash' tool plug-in.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>Hashes</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ToolGenerateHashPlugin.__init__">ToolGenerateHashPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__editorClosed">__editorClosed</a></td>
+<td>Private slot called, when an editor was closed.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__editorOpened">__editorOpened</a></td>
+<td>Private slot called, when a new editor was opened.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__hashDirectory">__hashDirectory</a></td>
+<td>Private slot to generate the hash for a directory.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__hashFile">__hashFile</a></td>
+<td>Private slot to generate the hash for a file.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__initMenus">__initMenus</a></td>
+<td>Private method to initialize the hash generation menus.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__insertHash">__insertHash</a></td>
+<td>Private method to insert the generated hash string.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.__populateMenu">__populateMenu</a></td>
+<td>Private slot to populate the tools menu with our entries.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#ToolGenerateHashPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plugin.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="ToolGenerateHashPlugin.__init__" ID="ToolGenerateHashPlugin.__init__"></a>
+<h4>ToolGenerateHashPlugin (Constructor)</h4>
+<b>ToolGenerateHashPlugin</b>(<i>ui</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>ui</i></dt>
+<dd>
+reference to the user interface object (UI.UserInterface)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.__editorClosed" ID="ToolGenerateHashPlugin.__editorClosed"></a>
+<h4>ToolGenerateHashPlugin.__editorClosed</h4>
+<b>__editorClosed</b>(<i>editor</i>)
+<p>
+ Private slot called, when an editor was closed.
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the editor (QScintilla.Editor)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.__editorOpened" ID="ToolGenerateHashPlugin.__editorOpened"></a>
+<h4>ToolGenerateHashPlugin.__editorOpened</h4>
+<b>__editorOpened</b>(<i>editor</i>)
+<p>
+ Private slot called, when a new editor was opened.
+</p><dl>
+<dt><i>editor</i></dt>
+<dd>
+reference to the new editor (QScintilla.Editor)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.__hashDirectory" ID="ToolGenerateHashPlugin.__hashDirectory"></a>
+<h4>ToolGenerateHashPlugin.__hashDirectory</h4>
+<b>__hashDirectory</b>(<i></i>)
+<p>
+ Private slot to generate the hash for a directory.
+</p><a NAME="ToolGenerateHashPlugin.__hashFile" ID="ToolGenerateHashPlugin.__hashFile"></a>
+<h4>ToolGenerateHashPlugin.__hashFile</h4>
+<b>__hashFile</b>(<i></i>)
+<p>
+ Private slot to generate the hash for a file.
+</p><a NAME="ToolGenerateHashPlugin.__initMenus" ID="ToolGenerateHashPlugin.__initMenus"></a>
+<h4>ToolGenerateHashPlugin.__initMenus</h4>
+<b>__initMenus</b>(<i></i>)
+<p>
+ Private method to initialize the hash generation menus.
+</p><a NAME="ToolGenerateHashPlugin.__insertHash" ID="ToolGenerateHashPlugin.__insertHash"></a>
+<h4>ToolGenerateHashPlugin.__insertHash</h4>
+<b>__insertHash</b>(<i>hashStr</i>)
+<p>
+ Private method to insert the generated hash string.
+</p><dl>
+<dt><i>hashStr</i></dt>
+<dd>
+hash string (string)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.__loadTranslator" ID="ToolGenerateHashPlugin.__loadTranslator"></a>
+<h4>ToolGenerateHashPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+ Private method to load the translation file.
+</p><a NAME="ToolGenerateHashPlugin.__populateMenu" ID="ToolGenerateHashPlugin.__populateMenu"></a>
+<h4>ToolGenerateHashPlugin.__populateMenu</h4>
+<b>__populateMenu</b>(<i>name, menu</i>)
+<p>
+ Private slot to populate the tools menu with our entries.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the menu (string)
+</dd><dt><i>menu</i></dt>
+<dd>
+reference to the menu to be populated (QMenu)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.activate" ID="ToolGenerateHashPlugin.activate"></a>
+<h4>ToolGenerateHashPlugin.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+ Public method to activate this plugin.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of None and activation status (boolean)
+</dd>
+</dl><a NAME="ToolGenerateHashPlugin.deactivate" ID="ToolGenerateHashPlugin.deactivate"></a>
+<h4>ToolGenerateHashPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+ Public method to deactivate this plugin.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
