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 78
- a22328182bc2
- parent 37
- 8bc357057af3
- child 87
- fe391e485681
equal
deleted
inserted
replaced
| 77:a580238d85de | 78:a22328182bc2 |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1> | 23 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog to enter MQTT connection options. | 26 Module implementing a dialog to enter MQTT connection options. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> | 38 <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> |
| 34 <td>Class implementing a dialog to enter MQTT connection options.</td> | 39 <td>Class implementing a dialog to enter MQTT connection options.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> | 49 <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> |
| 43 <h2>MqttConnectionOptionsDialog</h2> | 50 <h2>MqttConnectionOptionsDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing a dialog to enter MQTT connection options. | 53 Class implementing a dialog to enter MQTT connection options. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QDialog, Ui_MqttConnectionOptionsDialog | 56 QDialog, Ui_MqttConnectionOptionsDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> | 72 <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> | 76 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> |
| 64 <td>Private method to populate the dialog.</td> | 77 <td>Private method to populate the dialog.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> | 80 <td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> |
| 67 <td>Private method to update the enabled state of the OK button.</td> | 81 <td>Private method to update the enabled state of the OK button.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> | 84 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> |
| 70 <td>Public method get the entered connection options.</td> | 85 <td>Public method get the entered connection options.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 88 <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 73 <td>Private slot to handle the press of a button box button.</td> | 89 <td>Private slot to handle the press of a button box button.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked">on_cleanSessionCheckBox_clicked</a></td> | 92 <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> | 93 <td>Private slot to handle a change of the clean session selection.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#MqttConnectionOptionsDialog.on_clientIdEdit_textChanged">on_clientIdEdit_textChanged</a></td> | 96 <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> | 97 <td>Private slot handling a change of the client ID string.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> | 100 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> |
| 82 <td>Private slot to generate a client ID.</td> | 101 <td>Private slot to generate a client ID.</td> |
| 83 </tr> | 102 </tr> |
| 84 </table> | 103 </table> |
| 85 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 86 <table> | 105 |
| 87 <tr><td>None</td></tr> | 106 <table> |
| 88 </table> | 107 <tr><td>None</td></tr> |
| 108 </table> | |
| 109 | |
| 89 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> | 110 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> |
| 90 <h4>MqttConnectionOptionsDialog (Constructor)</h4> | 111 <h4>MqttConnectionOptionsDialog (Constructor)</h4> |
| 91 <b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>) | 112 <b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>) |
| 113 | |
| 92 <p> | 114 <p> |
| 93 Constructor | 115 Constructor |
| 94 </p><dl> | 116 </p> |
| 117 <dl> | |
| 118 | |
| 95 <dt><i>client</i> (MqttClient)</dt> | 119 <dt><i>client</i> (MqttClient)</dt> |
| 96 <dd> | 120 <dd> |
| 97 reference to the MQTT client object | 121 reference to the MQTT client object |
| 98 </dd><dt><i>options</i> (dict)</dt> | 122 </dd> |
| 123 <dt><i>options</i> (dict)</dt> | |
| 99 <dd> | 124 <dd> |
| 100 dictionary containing the connection options to | 125 dictionary containing the connection options to |
| 101 populate the dialog with. It must have the keys "ClientId", | 126 populate the dialog with. It must have the keys "ClientId", |
| 102 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", | 127 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", |
| 103 "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", | 128 "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", |
| 104 "ConnectionTimeout". | 129 "ConnectionTimeout". |
| 105 </dd><dt><i>parent</i> (QWidget)</dt> | 130 </dd> |
| 131 <dt><i>parent</i> (QWidget)</dt> | |
| 106 <dd> | 132 <dd> |
| 107 reference to the parent widget | 133 reference to the parent widget |
| 108 </dd> | 134 </dd> |
| 109 </dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> | 135 </dl> |
| 136 <a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> | |
| 110 <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> | 137 <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> |
| 111 <b>__populateDefaults</b>(<i>options=None</i>) | 138 <b>__populateDefaults</b>(<i>options=None</i>) |
| 139 | |
| 112 <p> | 140 <p> |
| 113 Private method to populate the dialog. | 141 Private method to populate the dialog. |
| 114 </p><p> | 142 </p> |
| 143 <p> | |
| 115 If no options dictionary is given, the dialog will be populated with | 144 If no options dictionary is given, the dialog will be populated with |
| 116 default values. | 145 default values. |
| 117 </p><dl> | 146 </p> |
| 147 <dl> | |
| 148 | |
| 118 <dt><i>options</i> (dict)</dt> | 149 <dt><i>options</i> (dict)</dt> |
| 119 <dd> | 150 <dd> |
| 120 dictionary containing the connection options to populate | 151 dictionary containing the connection options to populate |
| 121 the dialog with. It must have the keys "ClientId", "Keepalive", | 152 the dialog with. It must have the keys "ClientId", "Keepalive", |
| 122 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", | 153 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", |
| 123 "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", | 154 "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", |
| 124 "ConnectionTimeout". | 155 "ConnectionTimeout". |
| 125 </dd> | 156 </dd> |
| 126 </dl><a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> | 157 </dl> |
| 158 <a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> | |
| 127 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> | 159 <h4>MqttConnectionOptionsDialog.__updateOkButton</h4> |
| 128 <b>__updateOkButton</b>(<i></i>) | 160 <b>__updateOkButton</b>(<i></i>) |
| 161 | |
| 129 <p> | 162 <p> |
| 130 Private method to update the enabled state of the OK button. | 163 Private method to update the enabled state of the OK button. |
| 131 </p><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | 164 </p> |
| 165 <a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | |
| 132 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> | 166 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> |
| 133 <b>getConnectionOptions</b>(<i></i>) | 167 <b>getConnectionOptions</b>(<i></i>) |
| 168 | |
| 134 <p> | 169 <p> |
| 135 Public method get the entered connection options. | 170 Public method get the entered connection options. |
| 136 </p><dl> | 171 </p> |
| 172 <dl> | |
| 137 <dt>Returns:</dt> | 173 <dt>Returns:</dt> |
| 138 <dd> | 174 <dd> |
| 139 dictionary containing the connection options. It has the keys | 175 dictionary containing the connection options. It has the keys |
| 140 "ClientId", "Keepalive", "CleanSession", "Username", "Password", | 176 "ClientId", "Keepalive", "CleanSession", "Username", "Password", |
| 141 "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", | 177 "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", |
| 142 "TlsCaCert", "ConnectionTimeout". | 178 "TlsCaCert", "ConnectionTimeout". |
| 143 </dd> | 179 </dd> |
| 144 </dl><dl> | 180 </dl> |
| 181 <dl> | |
| 145 <dt>Return Type:</dt> | 182 <dt>Return Type:</dt> |
| 146 <dd> | 183 <dd> |
| 147 tuple of (int, dict) | 184 tuple of (int, dict) |
| 148 </dd> | 185 </dd> |
| 149 </dl><a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> | 186 </dl> |
| 187 <a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> | |
| 150 <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> | 188 <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> |
| 151 <b>on_buttonBox_clicked</b>(<i>button</i>) | 189 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 190 | |
| 152 <p> | 191 <p> |
| 153 Private slot to handle the press of a button box button. | 192 Private slot to handle the press of a button box button. |
| 154 </p><dl> | 193 </p> |
| 194 <dl> | |
| 195 | |
| 155 <dt><i>button</i> (QAbstractButton)</dt> | 196 <dt><i>button</i> (QAbstractButton)</dt> |
| 156 <dd> | 197 <dd> |
| 157 button that has been pressed | 198 button that has been pressed |
| 158 </dd> | 199 </dd> |
| 159 </dl><a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> | 200 </dl> |
| 201 <a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> | |
| 160 <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> | 202 <h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> |
| 161 <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) | 203 <b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) |
| 204 | |
| 162 <p> | 205 <p> |
| 163 Private slot to handle a change of the clean session selection. | 206 Private slot to handle a change of the clean session selection. |
| 164 </p><dl> | 207 </p> |
| 208 <dl> | |
| 209 | |
| 165 <dt><i>checked</i> (bool)</dt> | 210 <dt><i>checked</i> (bool)</dt> |
| 166 <dd> | 211 <dd> |
| 167 current state of the clean session selection | 212 current state of the clean session selection |
| 168 </dd> | 213 </dd> |
| 169 </dl><a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> | 214 </dl> |
| 215 <a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> | |
| 170 <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> | 216 <h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> |
| 171 <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) | 217 <b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) |
| 218 | |
| 172 <p> | 219 <p> |
| 173 Private slot handling a change of the client ID string. | 220 Private slot handling a change of the client ID string. |
| 174 </p><dl> | 221 </p> |
| 222 <dl> | |
| 223 | |
| 175 <dt><i>clientId</i> (str)</dt> | 224 <dt><i>clientId</i> (str)</dt> |
| 176 <dd> | 225 <dd> |
| 177 client ID | 226 client ID |
| 178 </dd> | 227 </dd> |
| 179 </dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> | 228 </dl> |
| 229 <a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> | |
| 180 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> | 230 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> |
| 181 <b>on_generateIdButton_clicked</b>(<i></i>) | 231 <b>on_generateIdButton_clicked</b>(<i></i>) |
| 232 | |
| 182 <p> | 233 <p> |
| 183 Private slot to generate a client ID. | 234 Private slot to generate a client ID. |
| 184 </p> | 235 </p> |
| 185 <div align="right"><a href="#top">Up</a></div> | 236 <div align="right"><a href="#top">Up</a></div> |
| 186 <hr /> | 237 <hr /> |
