MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html

branch
eric7
changeset 108
d7808a71b234
parent 92
2fb5c08019fd
child 115
357257ad48d2
equal deleted inserted replaced
107:639445679db1 108:d7808a71b234
26 Module implementing the MQTT Monitor plug-in. 26 Module implementing the MQTT Monitor plug-in.
27 </p> 27 </p>
28 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29 29
30 <table> 30 <table>
31 <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> 31 <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>mqttPluginObject</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>
32 </table> 32 </table>
33 <h3>Classes</h3> 33 <h3>Classes</h3>
34 34
35 <table> 35 <table>
36 36
42 <h3>Functions</h3> 42 <h3>Functions</h3>
43 43
44 <table> 44 <table>
45 45
46 <tr> 46 <tr>
47 <td><a href="#createMqttPage">createMqttPage</a></td>
48 <td>Module function to create the autocompletion configuration page.</td>
49 </tr>
50 <tr>
47 <td><a href="#exeDisplayData">exeDisplayData</a></td> 51 <td><a href="#exeDisplayData">exeDisplayData</a></td>
48 <td>Module function to support the display of some executable info.</td> 52 <td>Module function to support the display of some executable info.</td>
53 </tr>
54 <tr>
55 <td><a href="#getConfigData">getConfigData</a></td>
56 <td>Module function returning data as required by the configuration dialog.</td>
49 </tr> 57 </tr>
50 <tr> 58 <tr>
51 <td><a href="#installDependencies">installDependencies</a></td> 59 <td><a href="#installDependencies">installDependencies</a></td>
52 <td>Function to install dependencies of this plug-in.</td> 60 <td>Function to install dependencies of this plug-in.</td>
53 </tr> 61 </tr>
225 </dd> 233 </dd>
226 </dl> 234 </dl>
227 <div align="right"><a href="#top">Up</a></div> 235 <div align="right"><a href="#top">Up</a></div>
228 <hr /> 236 <hr />
229 <hr /> 237 <hr />
238 <a NAME="createMqttPage" ID="createMqttPage"></a>
239 <h2>createMqttPage</h2>
240 <b>createMqttPage</b>(<i>configDlg</i>)
241
242 <p>
243 Module function to create the autocompletion configuration page.
244 </p>
245 <dl>
246
247 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
248 <dd>
249 reference to the configuration dialog
250 </dd>
251 </dl>
252 <dl>
253 <dt>Return:</dt>
254 <dd>
255 reference to the configuration page
256 </dd>
257 </dl>
258 <dl>
259 <dt>Return Type:</dt>
260 <dd>
261 AutoCompletionRopePage
262 </dd>
263 </dl>
264 <div align="right"><a href="#top">Up</a></div>
265 <hr />
266 <hr />
230 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 267 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
231 <h2>exeDisplayData</h2> 268 <h2>exeDisplayData</h2>
232 <b>exeDisplayData</b>(<i></i>) 269 <b>exeDisplayData</b>(<i></i>)
233 270
234 <p> 271 <p>
248 </dd> 285 </dd>
249 </dl> 286 </dl>
250 <div align="right"><a href="#top">Up</a></div> 287 <div align="right"><a href="#top">Up</a></div>
251 <hr /> 288 <hr />
252 <hr /> 289 <hr />
290 <a NAME="getConfigData" ID="getConfigData"></a>
291 <h2>getConfigData</h2>
292 <b>getConfigData</b>(<i></i>)
293
294 <p>
295 Module function returning data as required by the configuration dialog.
296 </p>
297 <dl>
298 <dt>Return:</dt>
299 <dd>
300 dictionary containing the relevant data
301 </dd>
302 </dl>
303 <dl>
304 <dt>Return Type:</dt>
305 <dd>
306 dict
307 </dd>
308 </dl>
309 <div align="right"><a href="#top">Up</a></div>
310 <hr />
311 <hr />
253 <a NAME="installDependencies" ID="installDependencies"></a> 312 <a NAME="installDependencies" ID="installDependencies"></a>
254 <h2>installDependencies</h2> 313 <h2>installDependencies</h2>
255 <b>installDependencies</b>(<i>pipInstall</i>) 314 <b>installDependencies</b>(<i>pipInstall</i>)
256 315
257 <p> 316 <p>

eric ide

mercurial