Mercurial Repositories > IRC client / file comparison
comparison: ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.PluginExtensionIrc.html
ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.PluginExtensionIrc.html
- changeset 3
- 51c2c37bde76
equal
deleted
inserted
replaced
| 2:5b635dc8895f | 3:51c2c37bde76 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Irc.PluginExtensionIrc</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Extension_Irc.PluginExtensionIrc</h1> | |
| 10 <p> | |
| 11 Module implementing a plug-in providing IRC communication capability. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>__header__</td></tr> | |
| 17 <tr><td>error</td></tr> | |
| 18 <tr><td>ircExtensionPluginObject</td></tr> | |
| 19 </table> | |
| 20 | |
| 21 <h3>Classes</h3> | |
| 22 <table> | |
| 23 <tr> | |
| 24 <td><a href="#IrcExtensionPlugin">IrcExtensionPlugin</a></td> | |
| 25 <td>Class documentation goes here.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 | |
| 29 <h3>Functions</h3> | |
| 30 <table> | |
| 31 <tr> | |
| 32 <td><a href="#createIrcPage">createIrcPage</a></td> | |
| 33 <td>Function to create the IRC configuration page.</td> | |
| 34 </tr> | |
| 35 <tr> | |
| 36 <td><a href="#getConfigData">getConfigData</a></td> | |
| 37 <td>Function returning data as required by the configuration dialog.</td> | |
| 38 </tr> | |
| 39 <tr> | |
| 40 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 41 <td>Function to prepare for an un-installation.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="IrcExtensionPlugin" ID="IrcExtensionPlugin"></a> | |
| 48 <h2>IrcExtensionPlugin</h2> | |
| 49 <p> | |
| 50 Class documentation goes here. | |
| 51 </p> | |
| 52 | |
| 53 <h3>Derived from</h3> | |
| 54 QObject | |
| 55 <h3>Class Attributes</h3> | |
| 56 <table> | |
| 57 <tr><td>PreferencesKey</td></tr> | |
| 58 </table> | |
| 59 | |
| 60 <h3>Class Methods</h3> | |
| 61 <table> | |
| 62 <tr><td>None</td></tr> | |
| 63 </table> | |
| 64 | |
| 65 <h3>Methods</h3> | |
| 66 <table> | |
| 67 <tr> | |
| 68 <td><a href="#IrcExtensionPlugin.__init__">IrcExtensionPlugin</a></td> | |
| 69 <td>Constructor</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#IrcExtensionPlugin.__activateWidget">__activateWidget</a></td> | |
| 73 <td>Private slot to handle the activation of the MQTT Monitor.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#IrcExtensionPlugin.__getIconPaths">__getIconPaths</a></td> | |
| 77 <td>Private method to generate a list of paths to check for the requested icon name.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#IrcExtensionPlugin.__initialize">__initialize</a></td> | |
| 81 <td>Private slot to (re)initialize the plugin.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#IrcExtensionPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 85 <td>Private method to load the translation file.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#IrcExtensionPlugin.activate">activate</a></td> | |
| 89 <td>Public method to activate this plug-in.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#IrcExtensionPlugin.deactivate">deactivate</a></td> | |
| 93 <td>Public method to deactivate this plug-in.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#IrcExtensionPlugin.getIcon">getIcon</a></td> | |
| 97 <td>Public method to get a named icon.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#IrcExtensionPlugin.getPixmap">getPixmap</a></td> | |
| 101 <td>Public method to get a named pixmap.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#IrcExtensionPlugin.getPreferences">getPreferences</a></td> | |
| 105 <td>Public method to retrieve the various settings values.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#IrcExtensionPlugin.setPreferences">setPreferences</a></td> | |
| 109 <td>Public method to store the various settings values.</td> | |
| 110 </tr> | |
| 111 </table> | |
| 112 | |
| 113 <h3>Static Methods</h3> | |
| 114 <table> | |
| 115 <tr><td>None</td></tr> | |
| 116 </table> | |
| 117 | |
| 118 | |
| 119 <a NAME="IrcExtensionPlugin.__init__" ID="IrcExtensionPlugin.__init__"></a> | |
| 120 <h4>IrcExtensionPlugin (Constructor)</h4> | |
| 121 <b>IrcExtensionPlugin</b>(<i>ui</i>) | |
| 122 <p> | |
| 123 Constructor | |
| 124 </p> | |
| 125 | |
| 126 <dl> | |
| 127 | |
| 128 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 129 <dd> | |
| 130 reference to the user interface object | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <a NAME="IrcExtensionPlugin.__activateWidget" ID="IrcExtensionPlugin.__activateWidget"></a> | |
| 134 <h4>IrcExtensionPlugin.__activateWidget</h4> | |
| 135 <b>__activateWidget</b>(<i></i>) | |
| 136 <p> | |
| 137 Private slot to handle the activation of the MQTT Monitor. | |
| 138 </p> | |
| 139 | |
| 140 <a NAME="IrcExtensionPlugin.__getIconPaths" ID="IrcExtensionPlugin.__getIconPaths"></a> | |
| 141 <h4>IrcExtensionPlugin.__getIconPaths</h4> | |
| 142 <b>__getIconPaths</b>(<i>iconName</i>) | |
| 143 <p> | |
| 144 Private method to generate a list of paths to check for the requested icon name. | |
| 145 </p> | |
| 146 | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>iconName</i> (str)</dt> | |
| 150 <dd> | |
| 151 name of the icon | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <dl> | |
| 155 <dt>Return:</dt> | |
| 156 <dd> | |
| 157 list of icon path names | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <dl> | |
| 161 <dt>Return Type:</dt> | |
| 162 <dd> | |
| 163 list of str | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="IrcExtensionPlugin.__initialize" ID="IrcExtensionPlugin.__initialize"></a> | |
| 167 <h4>IrcExtensionPlugin.__initialize</h4> | |
| 168 <b>__initialize</b>(<i></i>) | |
| 169 <p> | |
| 170 Private slot to (re)initialize the plugin. | |
| 171 </p> | |
| 172 | |
| 173 <a NAME="IrcExtensionPlugin.__loadTranslator" ID="IrcExtensionPlugin.__loadTranslator"></a> | |
| 174 <h4>IrcExtensionPlugin.__loadTranslator</h4> | |
| 175 <b>__loadTranslator</b>(<i></i>) | |
| 176 <p> | |
| 177 Private method to load the translation file. | |
| 178 </p> | |
| 179 | |
| 180 <a NAME="IrcExtensionPlugin.activate" ID="IrcExtensionPlugin.activate"></a> | |
| 181 <h4>IrcExtensionPlugin.activate</h4> | |
| 182 <b>activate</b>(<i></i>) | |
| 183 <p> | |
| 184 Public method to activate this plug-in. | |
| 185 </p> | |
| 186 | |
| 187 <dl> | |
| 188 <dt>Return:</dt> | |
| 189 <dd> | |
| 190 tuple of None and activation status | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <dl> | |
| 194 <dt>Return Type:</dt> | |
| 195 <dd> | |
| 196 bool | |
| 197 </dd> | |
| 198 </dl> | |
| 199 <a NAME="IrcExtensionPlugin.deactivate" ID="IrcExtensionPlugin.deactivate"></a> | |
| 200 <h4>IrcExtensionPlugin.deactivate</h4> | |
| 201 <b>deactivate</b>(<i></i>) | |
| 202 <p> | |
| 203 Public method to deactivate this plug-in. | |
| 204 </p> | |
| 205 | |
| 206 <a NAME="IrcExtensionPlugin.getIcon" ID="IrcExtensionPlugin.getIcon"></a> | |
| 207 <h4>IrcExtensionPlugin.getIcon</h4> | |
| 208 <b>getIcon</b>(<i>iconName</i>) | |
| 209 <p> | |
| 210 Public method to get a named icon. | |
| 211 </p> | |
| 212 | |
| 213 <dl> | |
| 214 | |
| 215 <dt><i>iconName</i> (str)</dt> | |
| 216 <dd> | |
| 217 name of the icon | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <dl> | |
| 221 <dt>Return:</dt> | |
| 222 <dd> | |
| 223 requested icon | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <dl> | |
| 227 <dt>Return Type:</dt> | |
| 228 <dd> | |
| 229 QIcon | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <a NAME="IrcExtensionPlugin.getPixmap" ID="IrcExtensionPlugin.getPixmap"></a> | |
| 233 <h4>IrcExtensionPlugin.getPixmap</h4> | |
| 234 <b>getPixmap</b>(<i>pixmapName</i>) | |
| 235 <p> | |
| 236 Public method to get a named pixmap. | |
| 237 </p> | |
| 238 | |
| 239 <dl> | |
| 240 | |
| 241 <dt><i>pixmapName</i> (str)</dt> | |
| 242 <dd> | |
| 243 name of the pixmap | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <dl> | |
| 247 <dt>Return:</dt> | |
| 248 <dd> | |
| 249 requested pixmap | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <dl> | |
| 253 <dt>Return Type:</dt> | |
| 254 <dd> | |
| 255 QPixmap | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="IrcExtensionPlugin.getPreferences" ID="IrcExtensionPlugin.getPreferences"></a> | |
| 259 <h4>IrcExtensionPlugin.getPreferences</h4> | |
| 260 <b>getPreferences</b>(<i>key</i>) | |
| 261 <p> | |
| 262 Public method to retrieve the various settings values. | |
| 263 </p> | |
| 264 | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>key</i> (str)</dt> | |
| 268 <dd> | |
| 269 the key of the value to get | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <dl> | |
| 273 <dt>Return:</dt> | |
| 274 <dd> | |
| 275 the requested setting value | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <dl> | |
| 279 <dt>Return Type:</dt> | |
| 280 <dd> | |
| 281 Any | |
| 282 </dd> | |
| 283 </dl> | |
| 284 <a NAME="IrcExtensionPlugin.setPreferences" ID="IrcExtensionPlugin.setPreferences"></a> | |
| 285 <h4>IrcExtensionPlugin.setPreferences</h4> | |
| 286 <b>setPreferences</b>(<i>key, value</i>) | |
| 287 <p> | |
| 288 Public method to store the various settings values. | |
| 289 </p> | |
| 290 | |
| 291 <dl> | |
| 292 | |
| 293 <dt><i>key</i> (str)</dt> | |
| 294 <dd> | |
| 295 the key of the setting to be set | |
| 296 </dd> | |
| 297 <dt><i>value</i> (Any)</dt> | |
| 298 <dd> | |
| 299 the value to be set | |
| 300 </dd> | |
| 301 </dl> | |
| 302 <div align="right"><a href="#top">Up</a></div> | |
| 303 <hr /> | |
| 304 <hr /> | |
| 305 <a NAME="createIrcPage" ID="createIrcPage"></a> | |
| 306 <h2>createIrcPage</h2> | |
| 307 <b>createIrcPage</b>(<i>configDlg</i>) | |
| 308 <p> | |
| 309 Function to create the IRC configuration page. | |
| 310 </p> | |
| 311 | |
| 312 <dl> | |
| 313 | |
| 314 <dt><i>configDlg</i> (ConfigurationWidget)</dt> | |
| 315 <dd> | |
| 316 reference to the configuration dialog | |
| 317 </dd> | |
| 318 </dl> | |
| 319 <dl> | |
| 320 <dt>Return:</dt> | |
| 321 <dd> | |
| 322 reference to the configuration page | |
| 323 </dd> | |
| 324 </dl> | |
| 325 <dl> | |
| 326 <dt>Return Type:</dt> | |
| 327 <dd> | |
| 328 TranslatorPage | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <div align="right"><a href="#top">Up</a></div> | |
| 332 <hr /> | |
| 333 <hr /> | |
| 334 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 335 <h2>getConfigData</h2> | |
| 336 <b>getConfigData</b>(<i></i>) | |
| 337 <p> | |
| 338 Function returning data as required by the configuration dialog. | |
| 339 </p> | |
| 340 | |
| 341 <dl> | |
| 342 <dt>Return:</dt> | |
| 343 <dd> | |
| 344 dictionary containing the relevant data | |
| 345 </dd> | |
| 346 </dl> | |
| 347 <dl> | |
| 348 <dt>Return Type:</dt> | |
| 349 <dd> | |
| 350 dict | |
| 351 </dd> | |
| 352 </dl> | |
| 353 <div align="right"><a href="#top">Up</a></div> | |
| 354 <hr /> | |
| 355 <hr /> | |
| 356 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 357 <h2>prepareUninstall</h2> | |
| 358 <b>prepareUninstall</b>(<i></i>) | |
| 359 <p> | |
| 360 Function to prepare for an un-installation. | |
| 361 </p> | |
| 362 | |
| 363 <div align="right"><a href="#top">Up</a></div> | |
| 364 <hr /> | |
| 365 </body></html> |
