diff -r 639445679db1 -r d7808a71b234 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Jul 24 16:50:10 2021 +0200
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Jul 24 16:51:29 2021 +0200
@@ -77,6 +77,10 @@
<td>Private method to populate the dialog.</td>
</tr>
<tr>
+<td><a href="#MqttConnectionOptionsDialog.__propertiesTypeSelected">__propertiesTypeSelected</a></td>
+<td>Private slot to handle the switching of the user properties type.</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>
@@ -100,6 +104,18 @@
<td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td>
<td>Private slot to generate a client ID.</td>
</tr>
+<tr>
+<td><a href="#MqttConnectionOptionsDialog.on_mqttv5Button_toggled">on_mqttv5Button_toggled</a></td>
+<td>Private slot to handle the selection of the MQTT protocol.</td>
+</tr>
+<tr>
+<td><a href="#MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled">on_samePropertiesCheckBox_toggled</a></td>
+<td>Private slot to handle a change of the properties usage.</td>
+</tr>
+<tr>
+<td><a href="#MqttConnectionOptionsDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td>
+<td>Private slot to edit the last will user properties.</td>
+</tr>
</table>
<h3>Static Methods</h3>
@@ -109,24 +125,21 @@
<a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a>
<h4>MqttConnectionOptionsDialog (Constructor)</h4>
-<b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>)
+<b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>)
<p>
Constructor
</p>
<dl>
-<dt><i>client</i> (MqttClient)</dt>
-<dd>
-reference to the MQTT client object
-</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", "TlsEnable", "TlsCaCert",
- "ConnectionTimeout".
+ "Protocol", "ConnectionTimeout", "Keepalive", "CleanSession",
+ "Username", "Password", "WillTopic", "WillMessage", "WillQos",
+ "WillRetain", "WillProperties", "TlsEnable", "TlsCaCert",
+ "UserProperties".
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
@@ -149,10 +162,24 @@
<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", "TlsEnable", "TlsCaCert",
- "ConnectionTimeout".
+ the dialog with. It must have the keys "ClientId", "Protocol",
+ "ConnectionTimeout", "Keepalive", "CleanSession", "Username",
+ "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain",
+ "WillProperties", "TlsEnable", "TlsCaCert", "UserProperties".
+</dd>
+</dl>
+<a NAME="MqttConnectionOptionsDialog.__propertiesTypeSelected" ID="MqttConnectionOptionsDialog.__propertiesTypeSelected"></a>
+<h4>MqttConnectionOptionsDialog.__propertiesTypeSelected</h4>
+<b>__propertiesTypeSelected</b>(<i>checked</i>)
+
+<p>
+ Private slot to handle the switching of the user properties type.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the buttons
</dd>
</dl>
<a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></a>
@@ -173,9 +200,10 @@
<dt>Return:</dt>
<dd>
dictionary containing the connection options. It has the keys
- "ClientId", "Keepalive", "CleanSession", "Username", "Password",
- "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable",
- "TlsCaCert", "ConnectionTimeout".
+ "ClientId", "Protocol", "ConnectionTimeout", "Keepalive",
+ "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
+ "WillQos", "WillRetain", "WillProperties", "TlsEnable",
+ "TlsCaCert", "UserProperties".
</dd>
</dl>
<dl>
@@ -233,6 +261,42 @@
<p>
Private slot to generate a client ID.
</p>
+<a NAME="MqttConnectionOptionsDialog.on_mqttv5Button_toggled" ID="MqttConnectionOptionsDialog.on_mqttv5Button_toggled"></a>
+<h4>MqttConnectionOptionsDialog.on_mqttv5Button_toggled</h4>
+<b>on_mqttv5Button_toggled</b>(<i>checked</i>)
+
+<p>
+ Private slot to handle the selection of the MQTT protocol.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+state of the button
+</dd>
+</dl>
+<a NAME="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled"></a>
+<h4>MqttConnectionOptionsDialog.on_samePropertiesCheckBox_toggled</h4>
+<b>on_samePropertiesCheckBox_toggled</b>(<i>checked</i>)
+
+<p>
+ Private slot to handle a change of the properties usage.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+flag indicating to use the same user properties for
+ CONNECT and DISCONNECT
+</dd>
+</dl>
+<a NAME="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked" ID="MqttConnectionOptionsDialog.on_willPropertiesButton_clicked"></a>
+<h4>MqttConnectionOptionsDialog.on_willPropertiesButton_clicked</h4>
+<b>on_willPropertiesButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to edit the last will user properties.
+</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>
\ No newline at end of file
