Mercurial Repositories > Eric Assistant / file comparison
comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html
AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html
- changeset 2
- 89cbc07f4bf0
- child 19
- 7eb775bb326b
equal
deleted
inserted
replaced
| 1:3a4123edc944 | 2:89cbc07f4bf0 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Assistant_Eric.PluginAssistantEric</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Assistant_Eric.PluginAssistantEric</h1> | |
| 24 <p> | |
| 25 Module implementing the Eric assistant plugin. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <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> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#AssistantEricPlugin">AssistantEricPlugin</a></td> | |
| 35 <td>Class implementing the Eric assistant plugin.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr> | |
| 41 <td><a href="#createAutoCompletionPage">createAutoCompletionPage</a></td> | |
| 42 <td>Module function to create the autocompletion configuration page.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#createCallTipsPage">createCallTipsPage</a></td> | |
| 45 <td>Module function to create the calltips configuration page.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#getConfigData">getConfigData</a></td> | |
| 48 <td>Module function returning data as required by the configuration dialog.</td> | |
| 49 </tr><tr> | |
| 50 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 51 <td>Module function to prepare for an uninstallation.</td> | |
| 52 </tr> | |
| 53 </table> | |
| 54 <hr /><hr /> | |
| 55 <a NAME="AssistantEricPlugin" ID="AssistantEricPlugin"></a> | |
| 56 <h2>AssistantEricPlugin</h2> | |
| 57 <p> | |
| 58 Class implementing the Eric assistant plugin. | |
| 59 </p> | |
| 60 <h3>Derived from</h3> | |
| 61 QObject | |
| 62 <h3>Class Attributes</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#AssistantEricPlugin.__init__">AssistantEricPlugin</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#AssistantEricPlugin.__checkQSql">__checkQSql</a></td> | |
| 73 <td>Private method to perform some checks on QSql.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#AssistantEricPlugin.__initialize">__initialize</a></td> | |
| 76 <td>Private slot to (re)initialize the plugin.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#AssistantEricPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 79 <td>Private method to load the translation file.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#AssistantEricPlugin.activate">activate</a></td> | |
| 82 <td>Public method to activate this plugin.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td> | |
| 85 <td>Public method to deactivate this plugin.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td> | |
| 88 <td>Public method to retrieve the various refactoring settings.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#AssistantEricPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 91 <td>Public method to prepare for an uninstallation.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td> | |
| 94 <td>Public method to store the various refactoring settings.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <a NAME="AssistantEricPlugin.__init__" ID="AssistantEricPlugin.__init__"></a> | |
| 98 <h4>AssistantEricPlugin (Constructor)</h4> | |
| 99 <b>AssistantEricPlugin</b>(<i>ui</i>) | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p><dl> | |
| 103 <dt><i>ui</i></dt> | |
| 104 <dd> | |
| 105 reference to the user interface object (UI.UserInterface) | |
| 106 </dd> | |
| 107 </dl><a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a> | |
| 108 <h4>AssistantEricPlugin.__checkQSql</h4> | |
| 109 <b>__checkQSql</b>(<i></i>) | |
| 110 <p> | |
| 111 Private method to perform some checks on QSql. | |
| 112 </p><dl> | |
| 113 <dt>Returns:</dt> | |
| 114 <dd> | |
| 115 flag indicating QSql is ok (boolean) | |
| 116 </dd> | |
| 117 </dl><a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a> | |
| 118 <h4>AssistantEricPlugin.__initialize</h4> | |
| 119 <b>__initialize</b>(<i></i>) | |
| 120 <p> | |
| 121 Private slot to (re)initialize the plugin. | |
| 122 </p><a NAME="AssistantEricPlugin.__loadTranslator" ID="AssistantEricPlugin.__loadTranslator"></a> | |
| 123 <h4>AssistantEricPlugin.__loadTranslator</h4> | |
| 124 <b>__loadTranslator</b>(<i></i>) | |
| 125 <p> | |
| 126 Private method to load the translation file. | |
| 127 </p><a NAME="AssistantEricPlugin.activate" ID="AssistantEricPlugin.activate"></a> | |
| 128 <h4>AssistantEricPlugin.activate</h4> | |
| 129 <b>activate</b>(<i></i>) | |
| 130 <p> | |
| 131 Public method to activate this plugin. | |
| 132 </p><dl> | |
| 133 <dt>Returns:</dt> | |
| 134 <dd> | |
| 135 tuple of None and activation status (boolean) | |
| 136 </dd> | |
| 137 </dl><a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a> | |
| 138 <h4>AssistantEricPlugin.deactivate</h4> | |
| 139 <b>deactivate</b>(<i></i>) | |
| 140 <p> | |
| 141 Public method to deactivate this plugin. | |
| 142 </p><a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a> | |
| 143 <h4>AssistantEricPlugin.getPreferences</h4> | |
| 144 <b>getPreferences</b>(<i>key</i>) | |
| 145 <p> | |
| 146 Public method to retrieve the various refactoring settings. | |
| 147 </p><dl> | |
| 148 <dt><i>key</i></dt> | |
| 149 <dd> | |
| 150 the key of the value to get | |
| 151 </dd><dt><i>prefClass</i></dt> | |
| 152 <dd> | |
| 153 preferences class used as the storage area | |
| 154 </dd> | |
| 155 </dl><dl> | |
| 156 <dt>Returns:</dt> | |
| 157 <dd> | |
| 158 the requested refactoring setting | |
| 159 </dd> | |
| 160 </dl><a NAME="AssistantEricPlugin.prepareUninstall" ID="AssistantEricPlugin.prepareUninstall"></a> | |
| 161 <h4>AssistantEricPlugin.prepareUninstall</h4> | |
| 162 <b>prepareUninstall</b>(<i></i>) | |
| 163 <p> | |
| 164 Public method to prepare for an uninstallation. | |
| 165 </p><a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a> | |
| 166 <h4>AssistantEricPlugin.setPreferences</h4> | |
| 167 <b>setPreferences</b>(<i>key, value</i>) | |
| 168 <p> | |
| 169 Public method to store the various refactoring settings. | |
| 170 </p><dl> | |
| 171 <dt><i>key</i></dt> | |
| 172 <dd> | |
| 173 the key of the setting to be set (string) | |
| 174 </dd><dt><i>value</i></dt> | |
| 175 <dd> | |
| 176 the value to be set | |
| 177 </dd><dt><i>prefClass</i></dt> | |
| 178 <dd> | |
| 179 preferences class used as the storage area | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <div align="right"><a href="#top">Up</a></div> | |
| 183 <hr /><hr /> | |
| 184 <a NAME="createAutoCompletionPage" ID="createAutoCompletionPage"></a> | |
| 185 <h2>createAutoCompletionPage</h2> | |
| 186 <b>createAutoCompletionPage</b>(<i>configDlg</i>) | |
| 187 <p> | |
| 188 Module function to create the autocompletion configuration page. | |
| 189 </p><dl> | |
| 190 <dt>Returns:</dt> | |
| 191 <dd> | |
| 192 reference to the configuration page | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <div align="right"><a href="#top">Up</a></div> | |
| 196 <hr /><hr /> | |
| 197 <a NAME="createCallTipsPage" ID="createCallTipsPage"></a> | |
| 198 <h2>createCallTipsPage</h2> | |
| 199 <b>createCallTipsPage</b>(<i>configDlg</i>) | |
| 200 <p> | |
| 201 Module function to create the calltips configuration page. | |
| 202 </p><dl> | |
| 203 <dt>Returns:</dt> | |
| 204 <dd> | |
| 205 reference to the configuration page | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /><hr /> | |
| 210 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 211 <h2>getConfigData</h2> | |
| 212 <b>getConfigData</b>(<i></i>) | |
| 213 <p> | |
| 214 Module function returning data as required by the configuration dialog. | |
| 215 </p><dl> | |
| 216 <dt>Returns:</dt> | |
| 217 <dd> | |
| 218 dictionary containing the relevant data | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <div align="right"><a href="#top">Up</a></div> | |
| 222 <hr /><hr /> | |
| 223 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 224 <h2>prepareUninstall</h2> | |
| 225 <b>prepareUninstall</b>(<i></i>) | |
| 226 <p> | |
| 227 Module function to prepare for an uninstallation. | |
| 228 </p> | |
| 229 <div align="right"><a href="#top">Up</a></div> | |
| 230 <hr /> | |
| 231 </body></html> |
