diff -r f8ff464db1f9 -r 8bc357057af3 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html --- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sun Sep 09 18:27:24 2018 +0200 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sun Sep 09 18:31:38 2018 +0200 @@ -63,12 +63,21 @@ <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> <td>Private method to populate the dialog.</td> </tr><tr> +<td><a href="#MqttConnectionOptionsDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to update the enabled state of the OK button.</td> +</tr><tr> <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> <td>Public method get the entered connection options.</td> </tr><tr> <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot to handle the press of a button box button.</td> </tr><tr> +<td><a href="#MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked">on_cleanSessionCheckBox_clicked</a></td> +<td>Private slot to handle a change of the clean session selection.</td> +</tr><tr> +<td><a href="#MqttConnectionOptionsDialog.on_clientIdEdit_textChanged">on_clientIdEdit_textChanged</a></td> +<td>Private slot handling a change of the client ID string.</td> +</tr><tr> <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> <td>Private slot to generate a client ID.</td> </tr> @@ -86,13 +95,13 @@ <dt><i>client</i> (MqttClient)</dt> <dd> reference to the MQTT client object -</dd><dt><i>options</i></dt> +</dd><dt><i>options</i> (dict)</dt> <dd> dictionary containing the connection options to populate the dialog with. It must have the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", "WillTopic", - "WillMessage", "WillQos", "WillRetain". -@type dict + "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", + "ConnectionTimeout". </dd><dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget @@ -111,9 +120,15 @@ dictionary containing the connection options to populate the dialog with. It must have the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", "WillTopic", "WillMessage", - "WillQos", "WillRetain". + "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", + "ConnectionTimeout". </dd> -</dl><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> +</dl><a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a> +<h4>MqttConnectionOptionsDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) +<p> + Private method to update the enabled state of the OK button. +</p><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> <b>getConnectionOptions</b>(<i></i>) <p> @@ -123,7 +138,8 @@ <dd> dictionary containing the connection options. It has the keys "ClientId", "Keepalive", "CleanSession", "Username", "Password", - "WillTopic", "WillMessage", "WillQos", "WillRetain". + "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", + "TlsCaCert", "ConnectionTimeout". </dd> </dl><dl> <dt>Return Type:</dt> @@ -140,6 +156,26 @@ <dd> button that has been pressed </dd> +</dl><a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> +<h4>MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked</h4> +<b>on_cleanSessionCheckBox_clicked</b>(<i>checked</i>) +<p> + Private slot to handle a change of the clean session selection. +</p><dl> +<dt><i>checked</i> (bool)</dt> +<dd> +current state of the clean session selection +</dd> +</dl><a NAME="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged" ID="MqttConnectionOptionsDialog.on_clientIdEdit_textChanged"></a> +<h4>MqttConnectionOptionsDialog.on_clientIdEdit_textChanged</h4> +<b>on_clientIdEdit_textChanged</b>(<i>clientId</i>) +<p> + Private slot handling a change of the client ID string. +</p><dl> +<dt><i>clientId</i> (str)</dt> +<dd> +client ID +</dd> </dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> <b>on_generateIdButton_clicked</b>(<i></i>)