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 141
- 864edfb1bb63
- parent 115
- 357257ad48d2
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.MqttMonitor.MqttConnectionOptionsDialog</h1> | 9 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to enter MQTT connection options. | 11 Module implementing a dialog to enter MQTT connection options. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> | 22 <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> |
| 25 <td>Class implementing a dialog to enter MQTT connection options.</td> | 23 <td>Class implementing a dialog to enter MQTT connection options.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> | 34 <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> |
| 36 <h2>MqttConnectionOptionsDialog</h2> | 35 <h2>MqttConnectionOptionsDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to enter MQTT connection options. | 37 Class implementing a dialog to enter MQTT connection options. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_MqttConnectionOptionsDialog | 41 QDialog, Ui_MqttConnectionOptionsDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | 43 <table> |
| 45 <table> | 44 <tr><td>None</td></tr> |
| 46 <tr><td>None</td></tr> | 45 </table> |
| 47 </table> | 46 |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> | 55 <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 101 <tr> | 98 <tr> |
| 102 <td><a href="#MqttConnectionOptionsDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td> | 99 <td><a href="#MqttConnectionOptionsDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td> |
| 103 <td>Private slot to edit the last will user properties.</td> | 100 <td>Private slot to edit the last will user properties.</td> |
| 104 </tr> | 101 </tr> |
| 105 </table> | 102 </table> |
| 103 | |
| 106 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 107 | 105 <table> |
| 108 <table> | 106 <tr><td>None</td></tr> |
| 109 <tr><td>None</td></tr> | 107 </table> |
| 110 </table> | 108 |
| 111 | 109 |
| 112 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> | 110 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> |
| 113 <h4>MqttConnectionOptionsDialog (Constructor)</h4> | 111 <h4>MqttConnectionOptionsDialog (Constructor)</h4> |
| 114 <b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>) | 112 <b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>) |
| 115 | |
| 116 <p> | 113 <p> |
| 117 Constructor | 114 Constructor |
| 118 </p> | 115 </p> |
| 116 | |
| 119 <dl> | 117 <dl> |
| 120 | 118 |
| 121 <dt><i>options</i> (dict)</dt> | 119 <dt><i>options</i> (dict)</dt> |
| 122 <dd> | 120 <dd> |
| 123 dictionary containing the connection options to | 121 dictionary containing the connection options to |
| 133 </dd> | 131 </dd> |
| 134 </dl> | 132 </dl> |
| 135 <a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> | 133 <a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> |
| 136 <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> | 134 <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> |
| 137 <b>__populateDefaults</b>(<i>options=None</i>) | 135 <b>__populateDefaults</b>(<i>options=None</i>) |
| 138 | |
| 139 <p> | 136 <p> |
| 140 Private method to populate the dialog. | 137 Private method to populate the dialog. |
| 141 </p> | 138 </p> |
| 142 <p> | 139 <p> |
| 143 If no options dictionary is given, the dialog will be populated with | 140 If no options dictionary is given, the dialog will be populated with |
| 144 default values. | 141 default values. |
| 145 </p> | 142 </p> |
| 143 | |
| 146 <dl> | 144 <dl> |
| 147 | 145 |
| 148 <dt><i>options</i> (dict)</dt> | 146 <dt><i>options</i> (dict)</dt> |
| 149 <dd> | 147 <dd> |
| 150 dictionary containing the connection options to populate | 148 dictionary containing the connection options to populate |
| 155 </dd> | 153 </dd> |
| 156 </dl> | 154 </dl> |
| 157 <a NAME="MqttConnectionOptionsDialog.__propertiesTypeSelected" ID="MqttConnectionOptionsDialog.__propertiesTypeSelected"></a> | 155 <a NAME="MqttConnectionOptionsDialog.__propertiesTypeSelected" ID="MqttConnectionOptionsDialog.__propertiesTypeSelected"></a> |
| 158 <h4>MqttConnectionOptionsDialog.__propertiesTypeSelected</h4> | 156 <h4>MqttConnectionOptionsDialog.__propertiesTypeSelected</h4> |
| 159 <b>__propertiesTypeSelected</b>(<i>checked</i>) | 157 <b>__propertiesTypeSelected</b>(<i>checked</i>) |
| 160 | |
| 161 <p> | 158 <p> |
| 162 Private slot to handle the switching of the user properties type. | 159 Private slot to handle the switching of the user properties type. |
| 163 </p> | 160 </p> |
| 161 | |
| 164 <dl> | 162 <dl> |
| 165 | 163 |
| 166 <dt><i>checked</i> (bool)</dt> | 164 <dt><i>checked</i> (bool)</dt> |
| 167 <dd> | 165 <dd> |
| 168 state of the buttons | 166 state of the buttons |
| 169 </dd> | 167 </dd> |
| 170 </dl> | 168 </dl> |
| 171 <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> | 169 <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> |
| 172 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> | 170 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> |
| 173 <b>__updateOkButton</b>(<i></i>) | 171 <b>__updateOkButton</b>(<i></i>) |
| 174 | |
| 175 <p> | 172 <p> |
| 176 Private method to update the enabled state of the OK button. | 173 Private method to update the enabled state of the OK button. |
| 177 </p> | 174 </p> |
| 175 | |
| 178 <a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | 176 <a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> |
| 179 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> | 177 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> |
| 180 <b>getConnectionOptions</b>(<i></i>) | 178 <b>getConnectionOptions</b>(<i></i>) |
| 181 | |
| 182 <p> | 179 <p> |
| 183 Public method get the entered connection options. | 180 Public method get the entered connection options. |
| 184 </p> | 181 </p> |
| 182 | |
| 185 <dl> | 183 <dl> |
| 186 <dt>Return:</dt> | 184 <dt>Return:</dt> |
| 187 <dd> | 185 <dd> |
| 188 dictionary containing the connection options. It has the keys | 186 dictionary containing the connection options. It has the keys |
| 189 "ClientId", "Protocol", "ConnectionTimeout", "Keepalive", | 187 "ClientId", "Protocol", "ConnectionTimeout", "Keepalive", |
| 199 </dd> | 197 </dd> |
| 200 </dl> | 198 </dl> |
| 201 <a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> | 199 <a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> |
| 202 <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> | 200 <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> |
| 203 <b>on_buttonBox_clicked</b>(<i>button</i>) | 201 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 204 | |
| 205 <p> | 202 <p> |
| 206 Private slot to handle the press of a button box button. | 203 Private slot to handle the press of a button box button. |
| 207 </p> | 204 </p> |
| 205 | |
| 208 <dl> | 206 <dl> |
| 209 | 207 |
| 210 <dt><i>button</i> (QAbstractButton)</dt> | 208 <dt><i>button</i> (QAbstractButton)</dt> |
| 211 <dd> | 209 <dd> |
| 212 button that has been pressed | 210 button that has been pressed |
| 213 </dd> | 211 </dd> |
| 214 </dl> | 212 </dl> |
| 215 <a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> | 213 <a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> |
| 216 <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> | 214 <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> |
| 217 <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) | 215 <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) |
| 218 | |
| 219 <p> | 216 <p> |
| 220 Private slot to handle a change of the clean session selection. | 217 Private slot to handle a change of the clean session selection. |
| 221 </p> | 218 </p> |
| 219 | |
| 222 <dl> | 220 <dl> |
| 223 | 221 |
| 224 <dt><i>checked</i> (bool)</dt> | 222 <dt><i>checked</i> (bool)</dt> |
| 225 <dd> | 223 <dd> |
| 226 current state of the clean session selection | 224 current state of the clean session selection |
| 227 </dd> | 225 </dd> |
| 228 </dl> | 226 </dl> |
| 229 <a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> | 227 <a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> |
| 230 <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> | 228 <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> |
| 231 <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) | 229 <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) |
| 232 | |
| 233 <p> | 230 <p> |
| 234 Private slot handling a change of the client ID string. | 231 Private slot handling a change of the client ID string. |
| 235 </p> | 232 </p> |
| 233 | |
| 236 <dl> | 234 <dl> |
| 237 | 235 |
| 238 <dt><i>clientId</i> (str)</dt> | 236 <dt><i>clientId</i> (str)</dt> |
| 239 <dd> | 237 <dd> |
| 240 client ID | 238 client ID |
| 241 </dd> | 239 </dd> |
| 242 </dl> | 240 </dl> |
| 243 <a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> | 241 <a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> |
| 244 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> | 242 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> |
| 245 <b>on_generateIdButton_clicked</b>(<i></i>) | 243 <b>on_generateIdButton_clicked</b>(<i></i>) |
| 246 | |
| 247 <p> | 244 <p> |
| 248 Private slot to generate a client ID. | 245 Private slot to generate a client ID. |
| 249 </p> | 246 </p> |
| 247 | |
| 250 <a NAME="MqttConnectionOptionsDialog.on_mqttv5Button_toggled" ID="MqttConnectionOptionsDialog.on_mqttv5Button_toggled"></a> | 248 <a NAME="MqttConnectionOptionsDialog.on_mqttv5Button_toggled" ID="MqttConnectionOptionsDialog.on_mqttv5Button_toggled"></a> |
| 251 <h4>MqttConnectionOptionsDialog.on_mqttv5Button_toggled</h4> | 249 <h4>MqttConnectionOptionsDialog.on_mqttv5Button_toggled</h4> |
| 252 <b>on_mqttv5Button_toggled</b>(<i>checked</i>) | 250 <b>on_mqttv5Button_toggled</b>(<i>checked</i>) |
| 253 | |
| 254 <p> | 251 <p> |
| 255 Private slot to handle the selection of the MQTT protocol. | 252 Private slot to handle the selection of the MQTT protocol. |
| 256 </p> | 253 </p> |
| 254 | |
| 257 <dl> | 255 <dl> |
| 258 | 256 |
| 259 <dt><i>checked</i> (bool)</dt> | 257 <dt><i>checked</i> (bool)</dt> |
| 260 <dd> | 258 <dd> |
| 261 state of the button | 259 state of the button |
| 262 </dd> | 260 </dd> |
| 263 </dl> | 261 </dl> |
| 264 <a NAME="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled"></a> | 262 <a NAME="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled"></a> |
| 265 <h4>MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled</h4> | 263 <h4>MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled</h4> |
| 266 <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) | 264 <b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>) |
| 267 | |
| 268 <p> | 265 <p> |
| 269 Private slot to handle a change of the properties usage. | 266 Private slot to handle a change of the properties usage. |
| 270 </p> | 267 </p> |
| 268 | |
| 271 <dl> | 269 <dl> |
| 272 | 270 |
| 273 <dt><i>checked</i> (bool)</dt> | 271 <dt><i>checked</i> (bool)</dt> |
| 274 <dd> | 272 <dd> |
| 275 flag indicating to use the same user properties for | 273 flag indicating to use the same user properties for |
| 277 </dd> | 275 </dd> |
| 278 </dl> | 276 </dl> |
| 279 <a NAME="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked" ID="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked"></a> | 277 <a NAME="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked" ID="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked"></a> |
| 280 <h4>MqttConnectionOptionsDialog.on_willPropertiesButton_clicked</h4> | 278 <h4>MqttConnectionOptionsDialog.on_willPropertiesButton_clicked</h4> |
| 281 <b>on_willPropertiesButton_clicked</b>(<i></i>) | 279 <b>on_willPropertiesButton_clicked</b>(<i></i>) |
| 282 | |
| 283 <p> | 280 <p> |
| 284 Private slot to edit the last will user properties. | 281 Private slot to edit the last will user properties. |
| 285 </p> | 282 </p> |
| 283 | |
| 286 <div align="right"><a href="#top">Up</a></div> | 284 <div align="right"><a href="#top">Up</a></div> |
| 287 <hr /> | 285 <hr /> |
| 288 </body></html> | 286 </body></html> |
