Mercurial Repositories > MQTT Monitor / file comparison
comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html
- changeset 12
- e0175cb7c5d5
- child 78
- a22328182bc2
equal
deleted
inserted
replaced
| 11:90d3ebed4cc0 | 12:e0175cb7c5d5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Mqtt_Monitor.PluginMqttMonitor</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1> | |
| 23 <p> | |
| 24 Module implementing the MQTT Monitor plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <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> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td> | |
| 34 <td>Class implementing the MQTT Monitor plug-in.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 41 <td>Module function to support the display of some executable info.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 44 <td>Module function to prepare for an uninstallation.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a> | |
| 49 <h2>MqttMonitorPlugin</h2> | |
| 50 <p> | |
| 51 Class implementing the MQTT Monitor plug-in. | |
| 52 </p> | |
| 53 <h3>Derived from</h3> | |
| 54 QObject | |
| 55 <h3>Class Attributes</h3> | |
| 56 <table> | |
| 57 <tr><td>PreferencesKey</td></tr> | |
| 58 </table> | |
| 59 <h3>Class Methods</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Methods</h3> | |
| 64 <table> | |
| 65 <tr> | |
| 66 <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#MqttMonitorPlugin.__activateWidget">__activateWidget</a></td> | |
| 70 <td>Private slot to handle the activation of the MQTT Monitor.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#MqttMonitorPlugin.__initialize">__initialize</a></td> | |
| 73 <td>Private slot to (re)initialize the plugin.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#MqttMonitorPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 76 <td>Private method to load the translation file.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#MqttMonitorPlugin.activate">activate</a></td> | |
| 79 <td>Public method to activate this plug-in.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#MqttMonitorPlugin.deactivate">deactivate</a></td> | |
| 82 <td>Public method to deactivate this plug-in.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#MqttMonitorPlugin.getPreferences">getPreferences</a></td> | |
| 85 <td>Public method to retrieve the various settings.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td> | |
| 88 <td>Public method to store the various settings.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a> | |
| 96 <h4>MqttMonitorPlugin (Constructor)</h4> | |
| 97 <b>MqttMonitorPlugin</b>(<i>ui</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 102 <dd> | |
| 103 reference to the user interface object | |
| 104 </dd> | |
| 105 </dl><a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a> | |
| 106 <h4>MqttMonitorPlugin.__activateWidget</h4> | |
| 107 <b>__activateWidget</b>(<i></i>) | |
| 108 <p> | |
| 109 Private slot to handle the activation of the MQTT Monitor. | |
| 110 </p><a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a> | |
| 111 <h4>MqttMonitorPlugin.__initialize</h4> | |
| 112 <b>__initialize</b>(<i></i>) | |
| 113 <p> | |
| 114 Private slot to (re)initialize the plugin. | |
| 115 </p><a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a> | |
| 116 <h4>MqttMonitorPlugin.__loadTranslator</h4> | |
| 117 <b>__loadTranslator</b>(<i></i>) | |
| 118 <p> | |
| 119 Private method to load the translation file. | |
| 120 </p><a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a> | |
| 121 <h4>MqttMonitorPlugin.activate</h4> | |
| 122 <b>activate</b>(<i></i>) | |
| 123 <p> | |
| 124 Public method to activate this plug-in. | |
| 125 </p><dl> | |
| 126 <dt>Returns:</dt> | |
| 127 <dd> | |
| 128 tuple of None and activation status | |
| 129 </dd> | |
| 130 </dl><dl> | |
| 131 <dt>Return Type:</dt> | |
| 132 <dd> | |
| 133 bool | |
| 134 </dd> | |
| 135 </dl><a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a> | |
| 136 <h4>MqttMonitorPlugin.deactivate</h4> | |
| 137 <b>deactivate</b>(<i></i>) | |
| 138 <p> | |
| 139 Public method to deactivate this plug-in. | |
| 140 </p><a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a> | |
| 141 <h4>MqttMonitorPlugin.getPreferences</h4> | |
| 142 <b>getPreferences</b>(<i>key</i>) | |
| 143 <p> | |
| 144 Public method to retrieve the various settings. | |
| 145 </p><dl> | |
| 146 <dt><i>key</i></dt> | |
| 147 <dd> | |
| 148 the key of the value to get | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Returns:</dt> | |
| 152 <dd> | |
| 153 the requested setting | |
| 154 </dd> | |
| 155 </dl><a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a> | |
| 156 <h4>MqttMonitorPlugin.setPreferences</h4> | |
| 157 <b>setPreferences</b>(<i>key, value</i>) | |
| 158 <p> | |
| 159 Public method to store the various settings. | |
| 160 </p><dl> | |
| 161 <dt><i>key</i></dt> | |
| 162 <dd> | |
| 163 the key of the setting to be set (string) | |
| 164 </dd><dt><i>value</i></dt> | |
| 165 <dd> | |
| 166 the value to be set | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /><hr /> | |
| 171 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 172 <h2>exeDisplayData</h2> | |
| 173 <b>exeDisplayData</b>(<i></i>) | |
| 174 <p> | |
| 175 Module function to support the display of some executable info. | |
| 176 </p><dl> | |
| 177 <dt>Returns:</dt> | |
| 178 <dd> | |
| 179 dictionary containing the data to query the presence of | |
| 180 the executable | |
| 181 </dd> | |
| 182 </dl><dl> | |
| 183 <dt>Return Type:</dt> | |
| 184 <dd> | |
| 185 dict | |
| 186 </dd> | |
| 187 </dl> | |
| 188 <div align="right"><a href="#top">Up</a></div> | |
| 189 <hr /><hr /> | |
| 190 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 191 <h2>prepareUninstall</h2> | |
| 192 <b>prepareUninstall</b>(<i></i>) | |
| 193 <p> | |
| 194 Module function to prepare for an uninstallation. | |
| 195 </p> | |
| 196 <div align="right"><a href="#top">Up</a></div> | |
| 197 <hr /> | |
| 198 </body></html> |
