Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html

MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html

branch
eric7
changeset 141
864edfb1bb63
parent 138
871d54655ef1
child 143
51bc5bcc672a
equal deleted inserted replaced
140:853ffd248dda 141:864edfb1bb63
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1> 9 <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1>
10
11 <p> 10 <p>
12 Module implementing the MQTT Monitor plug-in. 11 Module implementing the MQTT Monitor plug-in.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>_Side</td></tr>
17 <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> 17 <tr><td>author</td></tr>
18 </table> 18 <tr><td>autoactivate</td></tr>
19 <tr><td>className</td></tr>
20 <tr><td>deactivateable</td></tr>
21 <tr><td>error</td></tr>
22 <tr><td>longDescription</td></tr>
23 <tr><td>mqttPluginObject</td></tr>
24 <tr><td>name</td></tr>
25 <tr><td>needsRestart</td></tr>
26 <tr><td>packageName</td></tr>
27 <tr><td>pyqtApi</td></tr>
28 <tr><td>shortDescription</td></tr>
29 <tr><td>version</td></tr>
30 </table>
31
19 <h3>Classes</h3> 32 <h3>Classes</h3>
20 33 <table>
21 <table>
22
23 <tr> 34 <tr>
24 <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td> 35 <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td>
25 <td>Class implementing the MQTT Monitor plug-in.</td> 36 <td>Class implementing the MQTT Monitor plug-in.</td>
26 </tr> 37 </tr>
27 </table> 38 </table>
39
28 <h3>Functions</h3> 40 <h3>Functions</h3>
29 41 <table>
30 <table>
31
32 <tr> 42 <tr>
33 <td><a href="#createMqttPage">createMqttPage</a></td> 43 <td><a href="#createMqttPage">createMqttPage</a></td>
34 <td>Module function to create the autocompletion configuration page.</td> 44 <td>Module function to create the autocompletion configuration page.</td>
35 </tr> 45 </tr>
36 <tr> 46 <tr>
48 <tr> 58 <tr>
49 <td><a href="#prepareUninstall">prepareUninstall</a></td> 59 <td><a href="#prepareUninstall">prepareUninstall</a></td>
50 <td>Module function to prepare for an uninstallation.</td> 60 <td>Module function to prepare for an uninstallation.</td>
51 </tr> 61 </tr>
52 </table> 62 </table>
63
53 <hr /> 64 <hr />
54 <hr /> 65 <hr />
55 <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a> 66 <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a>
56 <h2>MqttMonitorPlugin</h2> 67 <h2>MqttMonitorPlugin</h2>
57
58 <p> 68 <p>
59 Class implementing the MQTT Monitor plug-in. 69 Class implementing the MQTT Monitor plug-in.
60 </p> 70 </p>
71
61 <h3>Derived from</h3> 72 <h3>Derived from</h3>
62 QObject 73 QObject
63 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
64
65 <table> 75 <table>
66 <tr><td>PreferencesKey</td></tr> 76 <tr><td>PreferencesKey</td></tr>
67 </table> 77 </table>
78
68 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
69
70 <table> 80 <table>
71 <tr><td>None</td></tr> 81 <tr><td>None</td></tr>
72 </table> 82 </table>
83
73 <h3>Methods</h3> 84 <h3>Methods</h3>
74 85 <table>
75 <table>
76
77 <tr> 86 <tr>
78 <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td> 87 <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td>
79 <td>Constructor</td> 88 <td>Constructor</td>
80 </tr> 89 </tr>
81 <tr> 90 <tr>
105 <tr> 114 <tr>
106 <td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td> 115 <td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td>
107 <td>Public method to store the various settings.</td> 116 <td>Public method to store the various settings.</td>
108 </tr> 117 </tr>
109 </table> 118 </table>
119
110 <h3>Static Methods</h3> 120 <h3>Static Methods</h3>
111
112 <table> 121 <table>
113 <tr><td>None</td></tr> 122 <tr><td>None</td></tr>
114 </table> 123 </table>
124
115 125
116 <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a> 126 <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a>
117 <h4>MqttMonitorPlugin (Constructor)</h4> 127 <h4>MqttMonitorPlugin (Constructor)</h4>
118 <b>MqttMonitorPlugin</b>(<i>ui</i>) 128 <b>MqttMonitorPlugin</b>(<i>ui</i>)
119
120 <p> 129 <p>
121 Constructor 130 Constructor
122 </p> 131 </p>
132
123 <dl> 133 <dl>
124 134
125 <dt><i>ui</i> (UI.UserInterface)</dt> 135 <dt><i>ui</i> (UI.UserInterface)</dt>
126 <dd> 136 <dd>
127 reference to the user interface object 137 reference to the user interface object
128 </dd> 138 </dd>
129 </dl> 139 </dl>
130 <a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a> 140 <a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a>
131 <h4>MqttMonitorPlugin.__activateWidget</h4> 141 <h4>MqttMonitorPlugin.__activateWidget</h4>
132 <b>__activateWidget</b>(<i></i>) 142 <b>__activateWidget</b>(<i></i>)
133
134 <p> 143 <p>
135 Private slot to handle the activation of the MQTT Monitor. 144 Private slot to handle the activation of the MQTT Monitor.
136 </p> 145 </p>
146
137 <a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a> 147 <a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a>
138 <h4>MqttMonitorPlugin.__initialize</h4> 148 <h4>MqttMonitorPlugin.__initialize</h4>
139 <b>__initialize</b>(<i></i>) 149 <b>__initialize</b>(<i></i>)
140
141 <p> 150 <p>
142 Private slot to (re)initialize the plugin. 151 Private slot to (re)initialize the plugin.
143 </p> 152 </p>
153
144 <a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a> 154 <a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a>
145 <h4>MqttMonitorPlugin.__loadTranslator</h4> 155 <h4>MqttMonitorPlugin.__loadTranslator</h4>
146 <b>__loadTranslator</b>(<i></i>) 156 <b>__loadTranslator</b>(<i></i>)
147
148 <p> 157 <p>
149 Private method to load the translation file. 158 Private method to load the translation file.
150 </p> 159 </p>
160
151 <a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a> 161 <a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a>
152 <h4>MqttMonitorPlugin.activate</h4> 162 <h4>MqttMonitorPlugin.activate</h4>
153 <b>activate</b>(<i></i>) 163 <b>activate</b>(<i></i>)
154
155 <p> 164 <p>
156 Public method to activate this plug-in. 165 Public method to activate this plug-in.
157 </p> 166 </p>
167
158 <dl> 168 <dl>
159 <dt>Return:</dt> 169 <dt>Return:</dt>
160 <dd> 170 <dd>
161 tuple of None and activation status 171 tuple of None and activation status
162 </dd> 172 </dd>
168 </dd> 178 </dd>
169 </dl> 179 </dl>
170 <a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a> 180 <a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a>
171 <h4>MqttMonitorPlugin.deactivate</h4> 181 <h4>MqttMonitorPlugin.deactivate</h4>
172 <b>deactivate</b>(<i></i>) 182 <b>deactivate</b>(<i></i>)
173
174 <p> 183 <p>
175 Public method to deactivate this plug-in. 184 Public method to deactivate this plug-in.
176 </p> 185 </p>
186
177 <a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a> 187 <a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a>
178 <h4>MqttMonitorPlugin.getPreferences</h4> 188 <h4>MqttMonitorPlugin.getPreferences</h4>
179 <b>getPreferences</b>(<i>key</i>) 189 <b>getPreferences</b>(<i>key</i>)
180
181 <p> 190 <p>
182 Public method to retrieve the various settings. 191 Public method to retrieve the various settings.
183 </p> 192 </p>
193
184 <dl> 194 <dl>
185 195
186 <dt><i>key</i> (str)</dt> 196 <dt><i>key</i> (str)</dt>
187 <dd> 197 <dd>
188 key of the setting 198 key of the setting
201 </dd> 211 </dd>
202 </dl> 212 </dl>
203 <a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a> 213 <a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a>
204 <h4>MqttMonitorPlugin.setPreferences</h4> 214 <h4>MqttMonitorPlugin.setPreferences</h4>
205 <b>setPreferences</b>(<i>key, value</i>) 215 <b>setPreferences</b>(<i>key, value</i>)
206
207 <p> 216 <p>
208 Public method to store the various settings. 217 Public method to store the various settings.
209 </p> 218 </p>
219
210 <dl> 220 <dl>
211 221
212 <dt><i>key</i> (str)</dt> 222 <dt><i>key</i> (str)</dt>
213 <dd> 223 <dd>
214 key of the setting to be set 224 key of the setting to be set
222 <hr /> 232 <hr />
223 <hr /> 233 <hr />
224 <a NAME="createMqttPage" ID="createMqttPage"></a> 234 <a NAME="createMqttPage" ID="createMqttPage"></a>
225 <h2>createMqttPage</h2> 235 <h2>createMqttPage</h2>
226 <b>createMqttPage</b>(<i>configDlg, </i>) 236 <b>createMqttPage</b>(<i>configDlg, </i>)
227
228 <p> 237 <p>
229 Module function to create the autocompletion configuration page. 238 Module function to create the autocompletion configuration page.
230 </p> 239 </p>
240
231 <dl> 241 <dl>
232 242
233 <dt><i>configDlg</i> (ConfigurationWidget)</dt> 243 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
234 <dd> 244 <dd>
235 reference to the configuration dialog 245 reference to the configuration dialog
251 <hr /> 261 <hr />
252 <hr /> 262 <hr />
253 <a NAME="exeDisplayData" ID="exeDisplayData"></a> 263 <a NAME="exeDisplayData" ID="exeDisplayData"></a>
254 <h2>exeDisplayData</h2> 264 <h2>exeDisplayData</h2>
255 <b>exeDisplayData</b>(<i></i>) 265 <b>exeDisplayData</b>(<i></i>)
256
257 <p> 266 <p>
258 Module function to support the display of some executable info. 267 Module function to support the display of some executable info.
259 </p> 268 </p>
269
260 <dl> 270 <dl>
261 <dt>Return:</dt> 271 <dt>Return:</dt>
262 <dd> 272 <dd>
263 dictionary containing the data to query the presence of 273 dictionary containing the data to query the presence of
264 the executable 274 the executable
274 <hr /> 284 <hr />
275 <hr /> 285 <hr />
276 <a NAME="getConfigData" ID="getConfigData"></a> 286 <a NAME="getConfigData" ID="getConfigData"></a>
277 <h2>getConfigData</h2> 287 <h2>getConfigData</h2>
278 <b>getConfigData</b>(<i></i>) 288 <b>getConfigData</b>(<i></i>)
279
280 <p> 289 <p>
281 Module function returning data as required by the configuration dialog. 290 Module function returning data as required by the configuration dialog.
282 </p> 291 </p>
292
283 <dl> 293 <dl>
284 <dt>Return:</dt> 294 <dt>Return:</dt>
285 <dd> 295 <dd>
286 dictionary containing the relevant data 296 dictionary containing the relevant data
287 </dd> 297 </dd>
296 <hr /> 306 <hr />
297 <hr /> 307 <hr />
298 <a NAME="installDependencies" ID="installDependencies"></a> 308 <a NAME="installDependencies" ID="installDependencies"></a>
299 <h2>installDependencies</h2> 309 <h2>installDependencies</h2>
300 <b>installDependencies</b>(<i>pipInstall</i>) 310 <b>installDependencies</b>(<i>pipInstall</i>)
301
302 <p> 311 <p>
303 Function to install dependencies of this plug-in. 312 Function to install dependencies of this plug-in.
304 </p> 313 </p>
314
305 <dl> 315 <dl>
306 316
307 <dt><i>pipInstall</i> (function)</dt> 317 <dt><i>pipInstall</i> (function)</dt>
308 <dd> 318 <dd>
309 function to be called with a list of package names. 319 function to be called with a list of package names.
313 <hr /> 323 <hr />
314 <hr /> 324 <hr />
315 <a NAME="prepareUninstall" ID="prepareUninstall"></a> 325 <a NAME="prepareUninstall" ID="prepareUninstall"></a>
316 <h2>prepareUninstall</h2> 326 <h2>prepareUninstall</h2>
317 <b>prepareUninstall</b>(<i></i>) 327 <b>prepareUninstall</b>(<i></i>)
318
319 <p> 328 <p>
320 Module function to prepare for an uninstallation. 329 Module function to prepare for an uninstallation.
321 </p> 330 </p>
331
322 <div align="right"><a href="#top">Up</a></div> 332 <div align="right"><a href="#top">Up</a></div>
323 <hr /> 333 <hr />
324 </body></html> 334 </body></html>

Mercurial Repository: MQTT Monitor

eric ide

mercurial