Mercurial Repositories > MQTT Monitor / file comparison
comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html
- branch
- eric7
- changeset 108
- d7808a71b234
- parent 95
- d830314cca87
- child 115
- 357257ad48d2
equal
deleted
inserted
replaced
| 107:639445679db1 | 108:d7808a71b234 |
|---|---|
| 99 <tr> | 99 <tr> |
| 100 <td><a href="#MqttConnectionProfilesDialog.__populateProfilesList">__populateProfilesList</a></td> | 100 <td><a href="#MqttConnectionProfilesDialog.__populateProfilesList">__populateProfilesList</a></td> |
| 101 <td>Private method to populate the list of defined profiles.</td> | 101 <td>Private method to populate the list of defined profiles.</td> |
| 102 </tr> | 102 </tr> |
| 103 <tr> | 103 <tr> |
| 104 <td><a href="#MqttConnectionProfilesDialog.__propertiesTypeSelected">__propertiesTypeSelected</a></td> | |
| 105 <td>Private slot to handle the switching of the user properties type.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 104 <td><a href="#MqttConnectionProfilesDialog.__resetProfile">__resetProfile</a></td> | 108 <td><a href="#MqttConnectionProfilesDialog.__resetProfile">__resetProfile</a></td> |
| 105 <td>Private method to reset the profile data entry fields to their stored values.</td> | 109 <td>Private method to reset the profile data entry fields to their stored values.</td> |
| 106 </tr> | 110 </tr> |
| 107 <tr> | 111 <tr> |
| 108 <td><a href="#MqttConnectionProfilesDialog.__updateApplyButton">__updateApplyButton</a></td> | 112 <td><a href="#MqttConnectionProfilesDialog.__updateApplyButton">__updateApplyButton</a></td> |
| 139 <tr> | 143 <tr> |
| 140 <td><a href="#MqttConnectionProfilesDialog.on_minusButton_clicked">on_minusButton_clicked</a></td> | 144 <td><a href="#MqttConnectionProfilesDialog.on_minusButton_clicked">on_minusButton_clicked</a></td> |
| 141 <td>Private slot to delete the selected entry.</td> | 145 <td>Private slot to delete the selected entry.</td> |
| 142 </tr> | 146 </tr> |
| 143 <tr> | 147 <tr> |
| 148 <td><a href="#MqttConnectionProfilesDialog.on_mqttv5Button_toggled">on_mqttv5Button_toggled</a></td> | |
| 149 <td>Private slot to handle the selection of the MQTT protocol.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 144 <td><a href="#MqttConnectionProfilesDialog.on_plusButton_clicked">on_plusButton_clicked</a></td> | 152 <td><a href="#MqttConnectionProfilesDialog.on_plusButton_clicked">on_plusButton_clicked</a></td> |
| 145 <td>Private slot to add a new empty profile entry.</td> | 153 <td>Private slot to add a new empty profile entry.</td> |
| 146 </tr> | 154 </tr> |
| 147 <tr> | 155 <tr> |
| 148 <td><a href="#MqttConnectionProfilesDialog.on_profileButtonBox_clicked">on_profileButtonBox_clicked</a></td> | 156 <td><a href="#MqttConnectionProfilesDialog.on_profileButtonBox_clicked">on_profileButtonBox_clicked</a></td> |
| 155 <tr> | 163 <tr> |
| 156 <td><a href="#MqttConnectionProfilesDialog.on_profilesList_currentItemChanged">on_profilesList_currentItemChanged</a></td> | 164 <td><a href="#MqttConnectionProfilesDialog.on_profilesList_currentItemChanged">on_profilesList_currentItemChanged</a></td> |
| 157 <td>Private slot to handle a change of the current profile.</td> | 165 <td>Private slot to handle a change of the current profile.</td> |
| 158 </tr> | 166 </tr> |
| 159 <tr> | 167 <tr> |
| 168 <td><a href="#MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled">on_samePropertiesCheckBox_toggled</a></td> | |
| 169 <td>Private slot to handle a change of the properties usage.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 160 <td><a href="#MqttConnectionProfilesDialog.on_showPasswordButton_toggled">on_showPasswordButton_toggled</a></td> | 172 <td><a href="#MqttConnectionProfilesDialog.on_showPasswordButton_toggled">on_showPasswordButton_toggled</a></td> |
| 161 <td>Private slot to show or hide the password.</td> | 173 <td>Private slot to show or hide the password.</td> |
| 162 </tr> | 174 </tr> |
| 163 <tr> | 175 <tr> |
| 164 <td><a href="#MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled">on_tlsCertsFileButton_toggled</a></td> | 176 <td><a href="#MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled">on_tlsCertsFileButton_toggled</a></td> |
| 189 <td>Private slot handling a change of the TLS client certificate file.</td> | 201 <td>Private slot handling a change of the TLS client certificate file.</td> |
| 190 </tr> | 202 </tr> |
| 191 <tr> | 203 <tr> |
| 192 <td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged">on_tlsSelfSignedClientKeyFilePicker_textChanged</a></td> | 204 <td><a href="#MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged">on_tlsSelfSignedClientKeyFilePicker_textChanged</a></td> |
| 193 <td>Private slot handling a change of the TLS client key file.</td> | 205 <td>Private slot handling a change of the TLS client key file.</td> |
| 206 </tr> | |
| 207 <tr> | |
| 208 <td><a href="#MqttConnectionProfilesDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td> | |
| 209 <td>Private slot to edit the last will user properties.</td> | |
| 194 </tr> | 210 </tr> |
| 195 <tr> | 211 <tr> |
| 196 <td><a href="#MqttConnectionProfilesDialog.reject">reject</a></td> | 212 <td><a href="#MqttConnectionProfilesDialog.reject">reject</a></td> |
| 197 <td>Public slot to reject the dialog changes.</td> | 213 <td>Public slot to reject the dialog changes.</td> |
| 198 </tr> | 214 </tr> |
| 203 <tr><td>None</td></tr> | 219 <tr><td>None</td></tr> |
| 204 </table> | 220 </table> |
| 205 | 221 |
| 206 <a NAME="MqttConnectionProfilesDialog.__init__" ID="MqttConnectionProfilesDialog.__init__"></a> | 222 <a NAME="MqttConnectionProfilesDialog.__init__" ID="MqttConnectionProfilesDialog.__init__"></a> |
| 207 <h4>MqttConnectionProfilesDialog (Constructor)</h4> | 223 <h4>MqttConnectionProfilesDialog (Constructor)</h4> |
| 208 <b>MqttConnectionProfilesDialog</b>(<i>client, profiles, parent=None</i>) | 224 <b>MqttConnectionProfilesDialog</b>(<i>profiles, currentProfile="", parent=None</i>) |
| 209 | 225 |
| 210 <p> | 226 <p> |
| 211 Constructor | 227 Constructor |
| 212 </p> | 228 </p> |
| 213 <dl> | 229 <dl> |
| 214 | 230 |
| 215 <dt><i>client</i> (MqttClient)</dt> | |
| 216 <dd> | |
| 217 reference to the MQTT client object | |
| 218 </dd> | |
| 219 <dt><i>profiles</i> (dict)</dt> | 231 <dt><i>profiles</i> (dict)</dt> |
| 220 <dd> | 232 <dd> |
| 221 dictionary containing dictionaries containing the | 233 dictionary containing dictionaries containing the |
| 222 connection parameters. Each entry must have the keys | 234 connection parameters. Each entry must have the keys |
| 223 "BrokerAddress", "BrokerPort", "ClientId", | 235 "BrokerAddress", "BrokerPort", "ClientId", "Protocol", |
| 224 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", | 236 "ConnectionTimeout", "Keepalive", "CleanSession", "Username", |
| 225 "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", | 237 "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", |
| 226 "TlsClientCert", "TlsClientKey", "ConnectionTimeout". | 238 "WillProperties", "TlsEnable", "TlsCaCert", "TlsClientCert", |
| 239 "TlsClientKey", "UserProperties". | |
| 240 </dd> | |
| 241 <dt><i>currentProfile</i> (str)</dt> | |
| 242 <dd> | |
| 243 name of the currently selected profile | |
| 227 </dd> | 244 </dd> |
| 228 <dt><i>parent</i> (QWidget)</dt> | 245 <dt><i>parent</i> (QWidget)</dt> |
| 229 <dd> | 246 <dd> |
| 230 reference to the parent widget | 247 reference to the parent widget |
| 231 </dd> | 248 </dd> |
| 329 <dt><i>currentProfile</i> (str)</dt> | 346 <dt><i>currentProfile</i> (str)</dt> |
| 330 <dd> | 347 <dd> |
| 331 name of the current profile | 348 name of the current profile |
| 332 </dd> | 349 </dd> |
| 333 </dl> | 350 </dl> |
| 351 <a NAME="MqttConnectionProfilesDialog.__propertiesTypeSelected" ID="MqttConnectionProfilesDialog.__propertiesTypeSelected"></a> | |
| 352 <h4>MqttConnectionProfilesDialog.__propertiesTypeSelected</h4> | |
| 353 <b>__propertiesTypeSelected</b>(<i>checked</i>) | |
| 354 | |
| 355 <p> | |
| 356 Private slot to handle the switching of the user properties type. | |
| 357 </p> | |
| 358 <dl> | |
| 359 | |
| 360 <dt><i>checked</i> (bool)</dt> | |
| 361 <dd> | |
| 362 state of the buttons | |
| 363 </dd> | |
| 364 </dl> | |
| 334 <a NAME="MqttConnectionProfilesDialog.__resetProfile" ID="MqttConnectionProfilesDialog.__resetProfile"></a> | 365 <a NAME="MqttConnectionProfilesDialog.__resetProfile" ID="MqttConnectionProfilesDialog.__resetProfile"></a> |
| 335 <h4>MqttConnectionProfilesDialog.__resetProfile</h4> | 366 <h4>MqttConnectionProfilesDialog.__resetProfile</h4> |
| 336 <b>__resetProfile</b>(<i></i>) | 367 <b>__resetProfile</b>(<i></i>) |
| 337 | 368 |
| 338 <p> | 369 <p> |
| 362 </p> | 393 </p> |
| 363 <dl> | 394 <dl> |
| 364 <dt>Return:</dt> | 395 <dt>Return:</dt> |
| 365 <dd> | 396 <dd> |
| 366 dictionary containing dictionaries containing the defined | 397 dictionary containing dictionaries containing the defined |
| 367 connection profiles. Each entry have the keys "BrokerAddress", | 398 connection profiles. Each entry has the keys "BrokerAddress", |
| 368 "BrokerPort", "ClientId", "Keepalive", "CleanSession", "Username", | 399 "BrokerPort", "ClientId", "Protocol", "ConnectionTimeout", |
| 369 "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", | 400 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", |
| 401 "WillMessage", "WillQos", "WillRetain", "WillProperties", | |
| 370 "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey", | 402 "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey", |
| 371 "ConnectionTimeout". | 403 "UserProperties". |
| 372 </dd> | 404 </dd> |
| 373 </dl> | 405 </dl> |
| 374 <dl> | 406 <dl> |
| 375 <dt>Return Type:</dt> | 407 <dt>Return Type:</dt> |
| 376 <dd> | 408 <dd> |
| 438 <b>on_minusButton_clicked</b>(<i></i>) | 470 <b>on_minusButton_clicked</b>(<i></i>) |
| 439 | 471 |
| 440 <p> | 472 <p> |
| 441 Private slot to delete the selected entry. | 473 Private slot to delete the selected entry. |
| 442 </p> | 474 </p> |
| 475 <a NAME="MqttConnectionProfilesDialog.on_mqttv5Button_toggled" ID="MqttConnectionProfilesDialog.on_mqttv5Button_toggled"></a> | |
| 476 <h4>MqttConnectionProfilesDialog.on_mqttv5Button_toggled</h4> | |
| 477 <b>on_mqttv5Button_toggled</b>(<i>checked</i>) | |
| 478 | |
| 479 <p> | |
| 480 Private slot to handle the selection of the MQTT protocol. | |
| 481 </p> | |
| 482 <dl> | |
| 483 | |
| 484 <dt><i>checked</i> (bool)</dt> | |
| 485 <dd> | |
| 486 state of the button | |
| 487 </dd> | |
| 488 </dl> | |
| 443 <a NAME="MqttConnectionProfilesDialog.on_plusButton_clicked" ID="MqttConnectionProfilesDialog.on_plusButton_clicked"></a> | 489 <a NAME="MqttConnectionProfilesDialog.on_plusButton_clicked" ID="MqttConnectionProfilesDialog.on_plusButton_clicked"></a> |
| 444 <h4>MqttConnectionProfilesDialog.on_plusButton_clicked</h4> | 490 <h4>MqttConnectionProfilesDialog.on_plusButton_clicked</h4> |
| 445 <b>on_plusButton_clicked</b>(<i></i>) | 491 <b>on_plusButton_clicked</b>(<i></i>) |
| 446 | 492 |
| 447 <p> | 493 <p> |
| 491 <dt><i>previous</i> (QListWidgetItem)</dt> | 537 <dt><i>previous</i> (QListWidgetItem)</dt> |
| 492 <dd> | 538 <dd> |
| 493 previous current item | 539 previous current item |
| 494 </dd> | 540 </dd> |
| 495 </dl> | 541 </dl> |
| 542 <a NAME="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled"></a> | |
| 543 <h4>MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled</h4> | |
| 544 <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) | |
| 545 | |
| 546 <p> | |
| 547 Private slot to handle a change of the properties usage. | |
| 548 </p> | |
| 549 <dl> | |
| 550 | |
| 551 <dt><i>checked</i> (bool)</dt> | |
| 552 <dd> | |
| 553 flag indicating to use the same user properties for | |
| 554 CONNECT and DISCONNECT | |
| 555 </dd> | |
| 556 </dl> | |
| 496 <a NAME="MqttConnectionProfilesDialog.on_showPasswordButton_toggled" ID="MqttConnectionProfilesDialog.on_showPasswordButton_toggled"></a> | 557 <a NAME="MqttConnectionProfilesDialog.on_showPasswordButton_toggled" ID="MqttConnectionProfilesDialog.on_showPasswordButton_toggled"></a> |
| 497 <h4>MqttConnectionProfilesDialog.on_showPasswordButton_toggled</h4> | 558 <h4>MqttConnectionProfilesDialog.on_showPasswordButton_toggled</h4> |
| 498 <b>on_showPasswordButton_toggled</b>(<i>checked</i>) | 559 <b>on_showPasswordButton_toggled</b>(<i>checked</i>) |
| 499 | 560 |
| 500 <p> | 561 <p> |
| 620 <dt><i>path</i> (str)</dt> | 681 <dt><i>path</i> (str)</dt> |
| 621 <dd> | 682 <dd> |
| 622 file path | 683 file path |
| 623 </dd> | 684 </dd> |
| 624 </dl> | 685 </dl> |
| 686 <a NAME="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked" ID="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked"></a> | |
| 687 <h4>MqttConnectionProfilesDialog.on_willPropertiesButton_clicked</h4> | |
| 688 <b>on_willPropertiesButton_clicked</b>(<i></i>) | |
| 689 | |
| 690 <p> | |
| 691 Private slot to edit the last will user properties. | |
| 692 </p> | |
| 625 <a NAME="MqttConnectionProfilesDialog.reject" ID="MqttConnectionProfilesDialog.reject"></a> | 693 <a NAME="MqttConnectionProfilesDialog.reject" ID="MqttConnectionProfilesDialog.reject"></a> |
| 626 <h4>MqttConnectionProfilesDialog.reject</h4> | 694 <h4>MqttConnectionProfilesDialog.reject</h4> |
| 627 <b>reject</b>(<i></i>) | 695 <b>reject</b>(<i></i>) |
| 628 | 696 |
| 629 <p> | 697 <p> |
