Mercurial Repositories > Eric Assistant / file diff

diff: AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html

AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html

changeset 163
842fce9b31ce
parent 138
e5f860436ab9
child 177
25cb41783971
--- a/AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html	Sat May 02 14:52:03 2020 +0200
+++ b/AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html	Mon Jun 22 19:16:15 2020 +0200
@@ -18,214 +18,279 @@
 
 </style>
 </head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
 <h1>Plugin_Assistant_Eric.PluginAssistantEric</h1>
+
 <p>
 Module implementing the Eric assistant plugin.
 </p>
 <h3>Global Attributes</h3>
+
 <table>
-<tr><td>assistantEricPluginObject</td></tr><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>shortDescription</td></tr><tr><td>version</td></tr>
+<tr><td>assistantEricPluginObject</td></tr><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="#AssistantEricPlugin">AssistantEricPlugin</a></td>
 <td>Class implementing the Eric assistant plugin.</td>
 </tr>
 </table>
 <h3>Functions</h3>
+
 <table>
+
 <tr>
 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td>
 <td>Module function to create the autocompletion configuration page.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#createCallTipsPage">createCallTipsPage</a></td>
 <td>Module function to create the calltips configuration page.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#getConfigData">getConfigData</a></td>
 <td>Module function returning data as required by the configuration dialog.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#prepareUninstall">prepareUninstall</a></td>
 <td>Module function to prepare for an uninstallation.</td>
 </tr>
 </table>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="AssistantEricPlugin" ID="AssistantEricPlugin"></a>
 <h2>AssistantEricPlugin</h2>
+
 <p>
     Class implementing the Eric assistant 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="#AssistantEricPlugin.__init__">AssistantEricPlugin</a></td>
 <td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.__checkQSql">__checkQSql</a></td>
 <td>Private method to perform some checks on QSql.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.__initialize">__initialize</a></td>
 <td>Private slot to (re)initialize the plugin.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.__loadTranslator">__loadTranslator</a></td>
 <td>Private method to load the translation file.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.activate">activate</a></td>
 <td>Public method to activate this plugin.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td>
 <td>Public method to deactivate this plugin.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td>
 <td>Public method to retrieve the various refactoring settings.</td>
-</tr><tr>
+</tr>
+<tr>
 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td>
 <td>Public method to store the various refactoring settings.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
+
 <table>
 <tr><td>None</td></tr>
 </table>
+
 <a NAME="AssistantEricPlugin.__init__" ID="AssistantEricPlugin.__init__"></a>
 <h4>AssistantEricPlugin (Constructor)</h4>
 <b>AssistantEricPlugin</b>(<i>ui</i>)
+
 <p>
         Constructor
-</p><dl>
+</p>
+<dl>
+
 <dt><i>ui</i></dt>
 <dd>
 reference to the user interface object (UI.UserInterface)
 </dd>
-</dl><a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a>
+</dl>
+<a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a>
 <h4>AssistantEricPlugin.__checkQSql</h4>
 <b>__checkQSql</b>(<i></i>)
+
 <p>
         Private method to perform some checks on QSql.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating QSql is ok (boolean)
 </dd>
-</dl><a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a>
+</dl>
+<a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a>
 <h4>AssistantEricPlugin.__initialize</h4>
 <b>__initialize</b>(<i></i>)
+
 <p>
         Private slot to (re)initialize the plugin.
-</p><a NAME="AssistantEricPlugin.__loadTranslator" ID="AssistantEricPlugin.__loadTranslator"></a>
+</p>
+<a NAME="AssistantEricPlugin.__loadTranslator" ID="AssistantEricPlugin.__loadTranslator"></a>
 <h4>AssistantEricPlugin.__loadTranslator</h4>
 <b>__loadTranslator</b>(<i></i>)
+
 <p>
         Private method to load the translation file.
-</p><a NAME="AssistantEricPlugin.activate" ID="AssistantEricPlugin.activate"></a>
+</p>
+<a NAME="AssistantEricPlugin.activate" ID="AssistantEricPlugin.activate"></a>
 <h4>AssistantEricPlugin.activate</h4>
 <b>activate</b>(<i></i>)
+
 <p>
         Public method to activate this plugin.
-</p><dl>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 tuple of None and activation status (boolean)
 </dd>
-</dl><a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a>
+</dl>
+<a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a>
 <h4>AssistantEricPlugin.deactivate</h4>
 <b>deactivate</b>(<i></i>)
+
 <p>
         Public method to deactivate this plugin.
-</p><a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a>
+</p>
+<a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a>
 <h4>AssistantEricPlugin.getPreferences</h4>
 <b>getPreferences</b>(<i>key</i>)
+
 <p>
         Public method to retrieve the various refactoring settings.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>key</i></dt>
 <dd>
 the key of the value to get
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 the requested refactoring setting
 </dd>
-</dl><a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a>
+</dl>
+<a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a>
 <h4>AssistantEricPlugin.setPreferences</h4>
 <b>setPreferences</b>(<i>key, value</i>)
+
 <p>
         Public method to store the various refactoring settings.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>key</i></dt>
 <dd>
 the key of the setting to be set (string)
-</dd><dt><i>value</i></dt>
+</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 />
+<hr />
+<hr />
 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a>
 <h2>createAutoCompletionPage</h2>
 <b>createAutoCompletionPage</b>(<i>configDlg</i>)
+
 <p>
     Module function to create the autocompletion configuration page.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>configDlg</i></dt>
 <dd>
 reference to the configuration dialog
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 reference to the configuration page
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a>
 <h2>createCallTipsPage</h2>
 <b>createCallTipsPage</b>(<i>configDlg</i>)
+
 <p>
     Module function to create the calltips configuration page.
-</p><dl>
+</p>
+<dl>
+
 <dt><i>configDlg</i></dt>
 <dd>
 reference to the configuration dialog
 </dd>
-</dl><dl>
+</dl>
+<dl>
 <dt>Returns:</dt>
 <dd>
 reference to the configuration page
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>
+</p>
+<dl>
 <dt>Returns:</dt>
 <dd>
 dictionary containing the relevant data
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<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>

Mercurial Repository: Eric Assistant

eric ide

mercurial