--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PluginPrintRemover.html Wed Dec 18 09:26:02 2013 +0100
@@ -0,0 +1,216 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Tools_Print_Remover.PluginPrintRemover</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_Print_Remover.PluginPrintRemover</h1>
+<p>
+Module implementing the Print Remover 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>printRemoverPluginObject</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="#PrintRemoverPlugin">PrintRemoverPlugin</a></td>
+<td>Class implementing the Print Remover plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#createPrintRemoverPage">createPrintRemoverPage</a></td>
+<td>Module function to create the Print Remover configuration page.</td>
+</tr><tr>
+<td><a href="#getConfigData">getConfigData</a></td>
+<td>Module function returning data as required by the configuration dialog.</td>
+</tr><tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an uninstallation.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="PrintRemoverPlugin" ID="PrintRemoverPlugin"></a>
+<h2>PrintRemoverPlugin</h2>
+<p>
+ Class implementing the Print Remover plugin.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>PreferencesKey</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PrintRemoverPlugin.__init__">PrintRemoverPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.__populateMenu">__populateMenu</a></td>
+<td>Private slot to populate the tools menu with our entries.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.__removeLine">__removeLine</a></td>
+<td>Private slot to remove lines starting with the selected pattern.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plugin.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings.</td>
+</tr><tr>
+<td><a href="#PrintRemoverPlugin.setPreferences">setPreferences</a></td>
+<td>Public method to store the various settings.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="PrintRemoverPlugin.__init__" ID="PrintRemoverPlugin.__init__"></a>
+<h4>PrintRemoverPlugin (Constructor)</h4>
+<b>PrintRemoverPlugin</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="PrintRemoverPlugin.__loadTranslator" ID="PrintRemoverPlugin.__loadTranslator"></a>
+<h4>PrintRemoverPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+ Private method to load the translation file.
+</p><a NAME="PrintRemoverPlugin.__populateMenu" ID="PrintRemoverPlugin.__populateMenu"></a>
+<h4>PrintRemoverPlugin.__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="PrintRemoverPlugin.__removeLine" ID="PrintRemoverPlugin.__removeLine"></a>
+<h4>PrintRemoverPlugin.__removeLine</h4>
+<b>__removeLine</b>(<i></i>)
+<p>
+ Private slot to remove lines starting with the selected pattern.
+</p><a NAME="PrintRemoverPlugin.activate" ID="PrintRemoverPlugin.activate"></a>
+<h4>PrintRemoverPlugin.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="PrintRemoverPlugin.deactivate" ID="PrintRemoverPlugin.deactivate"></a>
+<h4>PrintRemoverPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+ Public method to deactivate this plugin.
+</p><a NAME="PrintRemoverPlugin.getPreferences" ID="PrintRemoverPlugin.getPreferences"></a>
+<h4>PrintRemoverPlugin.getPreferences</h4>
+<b>getPreferences</b>(<i>key</i>)
+<p>
+ Public method to retrieve the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the value to get (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the requested setting
+</dd>
+</dl><a NAME="PrintRemoverPlugin.setPreferences" ID="PrintRemoverPlugin.setPreferences"></a>
+<h4>PrintRemoverPlugin.setPreferences</h4>
+<b>setPreferences</b>(<i>key, value</i>)
+<p>
+ Public method to store the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the setting to be set (string)
+</dd><dt><i>value</i></dt>
+<dd>
+the value to be set
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createPrintRemoverPage" ID="createPrintRemoverPage"></a>
+<h2>createPrintRemoverPage</h2>
+<b>createPrintRemoverPage</b>(<i>configDlg</i>)
+<p>
+ Module function to create the Print Remover configuration page.
+</p><dl>
+<dt><i>configDlg</i></dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the configuration page
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="getConfigData" ID="getConfigData"></a>
+<h2>getConfigData</h2>
+<b>getConfigData</b>(<i></i>)
+<p>
+ Module function returning data as required by the configuration dialog.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the relevant data
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+<p>
+ Module function to prepare for an uninstallation.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
