--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html Mon Apr 21 16:11:49 2014 +0200
@@ -0,0 +1,278 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Tools_Selection_Encloser.PluginSelectionEncloser</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_Selection_Encloser.PluginSelectionEncloser</h1>
+<p>
+Module implementing the Selection Encloser 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>python2Compatible</td></tr><tr><td>selectionEncloserPluginObject</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#SelectionEncloserPlugin">SelectionEncloserPlugin</a></td>
+<td>Class implementing the Selection Encloser plugin.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#createSelectionEncloserPage">createSelectionEncloserPage</a></td>
+<td>Module function to create the Selection Encloser 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="SelectionEncloserPlugin" ID="SelectionEncloserPlugin"></a>
+<h2>SelectionEncloserPlugin</h2>
+<p>
+ Class implementing the Selection Encloser 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="#SelectionEncloserPlugin.__init__">SelectionEncloserPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__editorClosed">__editorClosed</a></td>
+<td>Private slot called, when an editor was closed.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__editorOpened">__editorOpened</a></td>
+<td>Private slot called, when a new editor was opened.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__editorShowMenu">__editorShowMenu</a></td>
+<td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__encloseSelection">__encloseSelection</a></td>
+<td>Private slot to enclose the selection with the selected string.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__initMenu">__initMenu</a></td>
+<td>Private method to initialize the menu.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__populateMenu">__populateMenu</a></td>
+<td>Private slot to populate the tools menu with our entry.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.__showMenu">__showMenu</a></td>
+<td>Private slot to build the menu hierarchy.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.activate">activate</a></td>
+<td>Public method to activate this plugin.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plugin.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings.</td>
+</tr><tr>
+<td><a href="#SelectionEncloserPlugin.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="SelectionEncloserPlugin.__init__" ID="SelectionEncloserPlugin.__init__"></a>
+<h4>SelectionEncloserPlugin (Constructor)</h4>
+<b>SelectionEncloserPlugin</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="SelectionEncloserPlugin.__editorClosed" ID="SelectionEncloserPlugin.__editorClosed"></a>
+<h4>SelectionEncloserPlugin.__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="SelectionEncloserPlugin.__editorOpened" ID="SelectionEncloserPlugin.__editorOpened"></a>
+<h4>SelectionEncloserPlugin.__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="SelectionEncloserPlugin.__editorShowMenu" ID="SelectionEncloserPlugin.__editorShowMenu"></a>
+<h4>SelectionEncloserPlugin.__editorShowMenu</h4>
+<b>__editorShowMenu</b>(<i>menuName, menu, editor</i>)
+<p>
+ Private slot called, when the the editor context menu or a submenu is
+ about to be shown.
+</p><dl>
+<dt><i>menuName</i></dt>
+<dd>
+name of the menu to be shown (string)
+</dd><dt><i>menu</i></dt>
+<dd>
+reference to the menu (QMenu)
+</dd><dt><i>editor</i></dt>
+<dd>
+reference to the editor
+</dd>
+</dl><a NAME="SelectionEncloserPlugin.__encloseSelection" ID="SelectionEncloserPlugin.__encloseSelection"></a>
+<h4>SelectionEncloserPlugin.__encloseSelection</h4>
+<b>__encloseSelection</b>(<i></i>)
+<p>
+ Private slot to enclose the selection with the selected string.
+</p><a NAME="SelectionEncloserPlugin.__initMenu" ID="SelectionEncloserPlugin.__initMenu"></a>
+<h4>SelectionEncloserPlugin.__initMenu</h4>
+<b>__initMenu</b>(<i></i>)
+<p>
+ Private method to initialize the menu.
+</p><a NAME="SelectionEncloserPlugin.__loadTranslator" ID="SelectionEncloserPlugin.__loadTranslator"></a>
+<h4>SelectionEncloserPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+ Private method to load the translation file.
+</p><a NAME="SelectionEncloserPlugin.__populateMenu" ID="SelectionEncloserPlugin.__populateMenu"></a>
+<h4>SelectionEncloserPlugin.__populateMenu</h4>
+<b>__populateMenu</b>(<i>name, menu</i>)
+<p>
+ Private slot to populate the tools menu with our entry.
+</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="SelectionEncloserPlugin.__showMenu" ID="SelectionEncloserPlugin.__showMenu"></a>
+<h4>SelectionEncloserPlugin.__showMenu</h4>
+<b>__showMenu</b>(<i></i>)
+<p>
+ Private slot to build the menu hierarchy.
+</p><a NAME="SelectionEncloserPlugin.activate" ID="SelectionEncloserPlugin.activate"></a>
+<h4>SelectionEncloserPlugin.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="SelectionEncloserPlugin.deactivate" ID="SelectionEncloserPlugin.deactivate"></a>
+<h4>SelectionEncloserPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+ Public method to deactivate this plugin.
+</p><a NAME="SelectionEncloserPlugin.getPreferences" ID="SelectionEncloserPlugin.getPreferences"></a>
+<h4>SelectionEncloserPlugin.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="SelectionEncloserPlugin.setPreferences" ID="SelectionEncloserPlugin.setPreferences"></a>
+<h4>SelectionEncloserPlugin.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="createSelectionEncloserPage" ID="createSelectionEncloserPage"></a>
+<h2>createSelectionEncloserPage</h2>
+<b>createSelectionEncloserPage</b>(<i>configDlg</i>)
+<p>
+ Module function to create the Selection Encloser 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
