Mercurial Repositories > MQTT Monitor / file comparison
comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
- branch
- eric7
- changeset 108
- d7808a71b234
- parent 92
- 2fb5c08019fd
- child 115
- 357257ad48d2
equal
deleted
inserted
replaced
| 107:639445679db1 | 108:d7808a71b234 |
|---|---|
| 75 <tr> | 75 <tr> |
| 76 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> | 76 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> |
| 77 <td>Private method to populate the dialog.</td> | 77 <td>Private method to populate the dialog.</td> |
| 78 </tr> | 78 </tr> |
| 79 <tr> | 79 <tr> |
| 80 <td><a href="#MqttConnectionOptionsDialog.__propertiesTypeSelected">__propertiesTypeSelected</a></td> | |
| 81 <td>Private slot to handle the switching of the user properties type.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 80 <td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> | 84 <td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> |
| 81 <td>Private method to update the enabled state of the OK button.</td> | 85 <td>Private method to update the enabled state of the OK button.</td> |
| 82 </tr> | 86 </tr> |
| 83 <tr> | 87 <tr> |
| 84 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> | 88 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> |
| 98 </tr> | 102 </tr> |
| 99 <tr> | 103 <tr> |
| 100 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> | 104 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> |
| 101 <td>Private slot to generate a client ID.</td> | 105 <td>Private slot to generate a client ID.</td> |
| 102 </tr> | 106 </tr> |
| 107 <tr> | |
| 108 <td><a href="#MqttConnectionOptionsDialog.on_mqttv5Button_toggled">on_mqttv5Button_toggled</a></td> | |
| 109 <td>Private slot to handle the selection of the MQTT protocol.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled">on_samePropertiesCheckBox_toggled</a></td> | |
| 113 <td>Private slot to handle a change of the properties usage.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#MqttConnectionOptionsDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td> | |
| 117 <td>Private slot to edit the last will user properties.</td> | |
| 118 </tr> | |
| 103 </table> | 119 </table> |
| 104 <h3>Static Methods</h3> | 120 <h3>Static Methods</h3> |
| 105 | 121 |
| 106 <table> | 122 <table> |
| 107 <tr><td>None</td></tr> | 123 <tr><td>None</td></tr> |
| 108 </table> | 124 </table> |
| 109 | 125 |
| 110 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> | 126 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> |
| 111 <h4>MqttConnectionOptionsDialog (Constructor)</h4> | 127 <h4>MqttConnectionOptionsDialog (Constructor)</h4> |
| 112 <b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>) | 128 <b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>) |
| 113 | 129 |
| 114 <p> | 130 <p> |
| 115 Constructor | 131 Constructor |
| 116 </p> | 132 </p> |
| 117 <dl> | 133 <dl> |
| 118 | 134 |
| 119 <dt><i>client</i> (MqttClient)</dt> | |
| 120 <dd> | |
| 121 reference to the MQTT client object | |
| 122 </dd> | |
| 123 <dt><i>options</i> (dict)</dt> | 135 <dt><i>options</i> (dict)</dt> |
| 124 <dd> | 136 <dd> |
| 125 dictionary containing the connection options to | 137 dictionary containing the connection options to |
| 126 populate the dialog with. It must have the keys "ClientId", | 138 populate the dialog with. It must have the keys "ClientId", |
| 127 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", | 139 "Protocol", "ConnectionTimeout", "Keepalive", "CleanSession", |
| 128 "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", | 140 "Username", "Password", "WillTopic", "WillMessage", "WillQos", |
| 129 "ConnectionTimeout". | 141 "WillRetain", "WillProperties", "TlsEnable", "TlsCaCert", |
| 142 "UserProperties". | |
| 130 </dd> | 143 </dd> |
| 131 <dt><i>parent</i> (QWidget)</dt> | 144 <dt><i>parent</i> (QWidget)</dt> |
| 132 <dd> | 145 <dd> |
| 133 reference to the parent widget | 146 reference to the parent widget |
| 134 </dd> | 147 </dd> |
| 147 <dl> | 160 <dl> |
| 148 | 161 |
| 149 <dt><i>options</i> (dict)</dt> | 162 <dt><i>options</i> (dict)</dt> |
| 150 <dd> | 163 <dd> |
| 151 dictionary containing the connection options to populate | 164 dictionary containing the connection options to populate |
| 152 the dialog with. It must have the keys "ClientId", "Keepalive", | 165 the dialog with. It must have the keys "ClientId", "Protocol", |
| 153 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", | 166 "ConnectionTimeout", "Keepalive", "CleanSession", "Username", |
| 154 "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", | 167 "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", |
| 155 "ConnectionTimeout". | 168 "WillProperties", "TlsEnable", "TlsCaCert", "UserProperties". |
| 169 </dd> | |
| 170 </dl> | |
| 171 <a NAME="MqttConnectionOptionsDialog.__propertiesTypeSelected" ID="MqttConnectionOptionsDialog.__propertiesTypeSelected"></a> | |
| 172 <h4>MqttConnectionOptionsDialog.__propertiesTypeSelected</h4> | |
| 173 <b>__propertiesTypeSelected</b>(<i>checked</i>) | |
| 174 | |
| 175 <p> | |
| 176 Private slot to handle the switching of the user properties type. | |
| 177 </p> | |
| 178 <dl> | |
| 179 | |
| 180 <dt><i>checked</i> (bool)</dt> | |
| 181 <dd> | |
| 182 state of the buttons | |
| 156 </dd> | 183 </dd> |
| 157 </dl> | 184 </dl> |
| 158 <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> | 185 <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> |
| 159 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> | 186 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> |
| 160 <b>__updateOkButton</b>(<i></i>) | 187 <b>__updateOkButton</b>(<i></i>) |
| 171 </p> | 198 </p> |
| 172 <dl> | 199 <dl> |
| 173 <dt>Return:</dt> | 200 <dt>Return:</dt> |
| 174 <dd> | 201 <dd> |
| 175 dictionary containing the connection options. It has the keys | 202 dictionary containing the connection options. It has the keys |
| 176 "ClientId", "Keepalive", "CleanSession", "Username", "Password", | 203 "ClientId", "Protocol", "ConnectionTimeout", "Keepalive", |
| 177 "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", | 204 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", |
| 178 "TlsCaCert", "ConnectionTimeout". | 205 "WillQos", "WillRetain", "WillProperties", "TlsEnable", |
| 206 "TlsCaCert", "UserProperties". | |
| 179 </dd> | 207 </dd> |
| 180 </dl> | 208 </dl> |
| 181 <dl> | 209 <dl> |
| 182 <dt>Return Type:</dt> | 210 <dt>Return Type:</dt> |
| 183 <dd> | 211 <dd> |
| 231 <b>on_generateIdButton_clicked</b>(<i></i>) | 259 <b>on_generateIdButton_clicked</b>(<i></i>) |
| 232 | 260 |
| 233 <p> | 261 <p> |
| 234 Private slot to generate a client ID. | 262 Private slot to generate a client ID. |
| 235 </p> | 263 </p> |
| 264 <a NAME="MqttConnectionOptionsDialog.on_mqttv5Button_toggled" ID="MqttConnectionOptionsDialog.on_mqttv5Button_toggled"></a> | |
| 265 <h4>MqttConnectionOptionsDialog.on_mqttv5Button_toggled</h4> | |
| 266 <b>on_mqttv5Button_toggled</b>(<i>checked</i>) | |
| 267 | |
| 268 <p> | |
| 269 Private slot to handle the selection of the MQTT protocol. | |
| 270 </p> | |
| 271 <dl> | |
| 272 | |
| 273 <dt><i>checked</i> (bool)</dt> | |
| 274 <dd> | |
| 275 state of the button | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <a NAME="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled"></a> | |
| 279 <h4>MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled</h4> | |
| 280 <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) | |
| 281 | |
| 282 <p> | |
| 283 Private slot to handle a change of the properties usage. | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>checked</i> (bool)</dt> | |
| 288 <dd> | |
| 289 flag indicating to use the same user properties for | |
| 290 CONNECT and DISCONNECT | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <a NAME="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked" ID="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked"></a> | |
| 294 <h4>MqttConnectionOptionsDialog.on_willPropertiesButton_clicked</h4> | |
| 295 <b>on_willPropertiesButton_clicked</b>(<i></i>) | |
| 296 | |
| 297 <p> | |
| 298 Private slot to edit the last will user properties. | |
| 299 </p> | |
| 236 <div align="right"><a href="#top">Up</a></div> | 300 <div align="right"><a href="#top">Up</a></div> |
| 237 <hr /> | 301 <hr /> |
| 238 </body></html> | 302 </body></html> |
