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
- changeset 37
- 8bc357057af3
- parent 12
- e0175cb7c5d5
- child 78
- a22328182bc2
equal
deleted
inserted
replaced
| 36:f8ff464db1f9 | 37:8bc357057af3 |
|---|---|
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> | 63 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> |
| 64 <td>Private method to populate the dialog.</td> | 64 <td>Private method to populate the dialog.</td> |
| 65 </tr><tr> | 65 </tr><tr> |
| 66 <td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> | |
| 67 <td>Private method to update the enabled state of the OK button.</td> | |
| 68 </tr><tr> | |
| 66 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> | 69 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> |
| 67 <td>Public method get the entered connection options.</td> | 70 <td>Public method get the entered connection options.</td> |
| 68 </tr><tr> | 71 </tr><tr> |
| 69 <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 72 <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 70 <td>Private slot to handle the press of a button box button.</td> | 73 <td>Private slot to handle the press of a button box button.</td> |
| 74 </tr><tr> | |
| 75 <td><a href="#MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked">on_cleanSessionCheckBox_clicked</a></td> | |
| 76 <td>Private slot to handle a change of the clean session selection.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#MqttConnectionOptionsDialog.on_clientIdEdit_textChanged">on_clientIdEdit_textChanged</a></td> | |
| 79 <td>Private slot handling a change of the client ID string.</td> | |
| 71 </tr><tr> | 80 </tr><tr> |
| 72 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> | 81 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> |
| 73 <td>Private slot to generate a client ID.</td> | 82 <td>Private slot to generate a client ID.</td> |
| 74 </tr> | 83 </tr> |
| 75 </table> | 84 </table> |
| 84 Constructor | 93 Constructor |
| 85 </p><dl> | 94 </p><dl> |
| 86 <dt><i>client</i> (MqttClient)</dt> | 95 <dt><i>client</i> (MqttClient)</dt> |
| 87 <dd> | 96 <dd> |
| 88 reference to the MQTT client object | 97 reference to the MQTT client object |
| 89 </dd><dt><i>options</i></dt> | 98 </dd><dt><i>options</i> (dict)</dt> |
| 90 <dd> | 99 <dd> |
| 91 dictionary containing the connection options to | 100 dictionary containing the connection options to |
| 92 populate the dialog with. It must have the keys "ClientId", | 101 populate the dialog with. It must have the keys "ClientId", |
| 93 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", | 102 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", |
| 94 "WillMessage", "WillQos", "WillRetain". | 103 "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", |
| 95 @type dict | 104 "ConnectionTimeout". |
| 96 </dd><dt><i>parent</i> (QWidget)</dt> | 105 </dd><dt><i>parent</i> (QWidget)</dt> |
| 97 <dd> | 106 <dd> |
| 98 reference to the parent widget | 107 reference to the parent widget |
| 99 </dd> | 108 </dd> |
| 100 </dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> | 109 </dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> |
| 109 <dt><i>options</i> (dict)</dt> | 118 <dt><i>options</i> (dict)</dt> |
| 110 <dd> | 119 <dd> |
| 111 dictionary containing the connection options to populate | 120 dictionary containing the connection options to populate |
| 112 the dialog with. It must have the keys "ClientId", "Keepalive", | 121 the dialog with. It must have the keys "ClientId", "Keepalive", |
| 113 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", | 122 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", |
| 114 "WillQos", "WillRetain". | 123 "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", |
| 124 "ConnectionTimeout". | |
| 115 </dd> | 125 </dd> |
| 116 </dl><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | 126 </dl><a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> |
| 127 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> | |
| 128 <b>__updateOkButton</b>(<i></i>) | |
| 129 <p> | |
| 130 Private method to update the enabled state of the OK button. | |
| 131 </p><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | |
| 117 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> | 132 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> |
| 118 <b>getConnectionOptions</b>(<i></i>) | 133 <b>getConnectionOptions</b>(<i></i>) |
| 119 <p> | 134 <p> |
| 120 Public method get the entered connection options. | 135 Public method get the entered connection options. |
| 121 </p><dl> | 136 </p><dl> |
| 122 <dt>Returns:</dt> | 137 <dt>Returns:</dt> |
| 123 <dd> | 138 <dd> |
| 124 dictionary containing the connection options. It has the keys | 139 dictionary containing the connection options. It has the keys |
| 125 "ClientId", "Keepalive", "CleanSession", "Username", "Password", | 140 "ClientId", "Keepalive", "CleanSession", "Username", "Password", |
| 126 "WillTopic", "WillMessage", "WillQos", "WillRetain". | 141 "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", |
| 142 "TlsCaCert", "ConnectionTimeout". | |
| 127 </dd> | 143 </dd> |
| 128 </dl><dl> | 144 </dl><dl> |
| 129 <dt>Return Type:</dt> | 145 <dt>Return Type:</dt> |
| 130 <dd> | 146 <dd> |
| 131 tuple of (int, dict) | 147 tuple of (int, dict) |
| 138 </p><dl> | 154 </p><dl> |
| 139 <dt><i>button</i> (QAbstractButton)</dt> | 155 <dt><i>button</i> (QAbstractButton)</dt> |
| 140 <dd> | 156 <dd> |
| 141 button that has been pressed | 157 button that has been pressed |
| 142 </dd> | 158 </dd> |
| 159 </dl><a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> | |
| 160 <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> | |
| 161 <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) | |
| 162 <p> | |
| 163 Private slot to handle a change of the clean session selection. | |
| 164 </p><dl> | |
| 165 <dt><i>checked</i> (bool)</dt> | |
| 166 <dd> | |
| 167 current state of the clean session selection | |
| 168 </dd> | |
| 169 </dl><a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> | |
| 170 <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> | |
| 171 <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) | |
| 172 <p> | |
| 173 Private slot handling a change of the client ID string. | |
| 174 </p><dl> | |
| 175 <dt><i>clientId</i> (str)</dt> | |
| 176 <dd> | |
| 177 client ID | |
| 178 </dd> | |
| 143 </dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> | 179 </dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> |
| 144 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> | 180 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> |
| 145 <b>on_generateIdButton_clicked</b>(<i></i>) | 181 <b>on_generateIdButton_clicked</b>(<i></i>) |
| 146 <p> | 182 <p> |
| 147 Private slot to generate a client ID. | 183 Private slot to generate a client ID. |
