--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sat Jul 24 16:50:10 2021 +0200
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sat Jul 24 16:51:29 2021 +0200
@@ -101,6 +101,10 @@
<td>Private method to populate the list of defined profiles.</td>
</tr>
<tr>
+<td><a href="#MqttConnectionProfilesDialog.__propertiesTypeSelected">__propertiesTypeSelected</a></td>
+<td>Private slot to handle the switching of the user properties type.</td>
+</tr>
+<tr>
<td><a href="#MqttConnectionProfilesDialog.__resetProfile">__resetProfile</a></td>
<td>Private method to reset the profile data entry fields to their stored values.</td>
</tr>
@@ -141,6 +145,10 @@
<td>Private slot to delete the selected entry.</td>
</tr>
<tr>
+<td><a href="#MqttConnectionProfilesDialog.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="#MqttConnectionProfilesDialog.on_plusButton_clicked">on_plusButton_clicked</a></td>
<td>Private slot to add a new empty profile entry.</td>
</tr>
@@ -157,6 +165,10 @@
<td>Private slot to handle a change of the current profile.</td>
</tr>
<tr>
+<td><a href="#MqttConnectionProfilesDialog.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="#MqttConnectionProfilesDialog.on_showPasswordButton_toggled">on_showPasswordButton_toggled</a></td>
<td>Private slot to show or hide the password.</td>
</tr>
@@ -193,6 +205,10 @@
<td>Private slot handling a change of the TLS client key file.</td>
</tr>
<tr>
+<td><a href="#MqttConnectionProfilesDialog.on_willPropertiesButton_clicked">on_willPropertiesButton_clicked</a></td>
+<td>Private slot to edit the last will user properties.</td>
+</tr>
+<tr>
<td><a href="#MqttConnectionProfilesDialog.reject">reject</a></td>
<td>Public slot to reject the dialog changes.</td>
</tr>
@@ -205,25 +221,26 @@
<a NAME="MqttConnectionProfilesDialog.__init__" ID="MqttConnectionProfilesDialog.__init__"></a>
<h4>MqttConnectionProfilesDialog (Constructor)</h4>
-<b>MqttConnectionProfilesDialog</b>(<i>client, profiles, parent=None</i>)
+<b>MqttConnectionProfilesDialog</b>(<i>profiles, currentProfile="", parent=None</i>)
<p>
Constructor
</p>
<dl>
-<dt><i>client</i> (MqttClient)</dt>
-<dd>
-reference to the MQTT client object
-</dd>
<dt><i>profiles</i> (dict)</dt>
<dd>
dictionary containing dictionaries containing the
connection parameters. Each entry must have the keys
- "BrokerAddress", "BrokerPort", "ClientId",
- "Keepalive", "CleanSession", "Username", "Password", "WillTopic",
- "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert",
- "TlsClientCert", "TlsClientKey", "ConnectionTimeout".
+ "BrokerAddress", "BrokerPort", "ClientId", "Protocol",
+ "ConnectionTimeout", "Keepalive", "CleanSession", "Username",
+ "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain",
+ "WillProperties", "TlsEnable", "TlsCaCert", "TlsClientCert",
+ "TlsClientKey", "UserProperties".
+</dd>
+<dt><i>currentProfile</i> (str)</dt>
+<dd>
+name of the currently selected profile
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
@@ -331,6 +348,20 @@
name of the current profile
</dd>
</dl>
+<a NAME="MqttConnectionProfilesDialog.__propertiesTypeSelected" ID="MqttConnectionProfilesDialog.__propertiesTypeSelected"></a>
+<h4>MqttConnectionProfilesDialog.__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="MqttConnectionProfilesDialog.__resetProfile" ID="MqttConnectionProfilesDialog.__resetProfile"></a>
<h4>MqttConnectionProfilesDialog.__resetProfile</h4>
<b>__resetProfile</b>(<i></i>)
@@ -364,11 +395,12 @@
<dt>Return:</dt>
<dd>
dictionary containing dictionaries containing the defined
- connection profiles. Each entry have the keys "BrokerAddress",
- "BrokerPort", "ClientId", "Keepalive", "CleanSession", "Username",
- "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain",
+ connection profiles. Each entry has the keys "BrokerAddress",
+ "BrokerPort", "ClientId", "Protocol", "ConnectionTimeout",
+ "Keepalive", "CleanSession", "Username", "Password", "WillTopic",
+ "WillMessage", "WillQos", "WillRetain", "WillProperties",
"TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey",
- "ConnectionTimeout".
+ "UserProperties".
</dd>
</dl>
<dl>
@@ -440,6 +472,20 @@
<p>
Private slot to delete the selected entry.
</p>
+<a NAME="MqttConnectionProfilesDialog.on_mqttv5Button_toggled" ID="MqttConnectionProfilesDialog.on_mqttv5Button_toggled"></a>
+<h4>MqttConnectionProfilesDialog.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="MqttConnectionProfilesDialog.on_plusButton_clicked" ID="MqttConnectionProfilesDialog.on_plusButton_clicked"></a>
<h4>MqttConnectionProfilesDialog.on_plusButton_clicked</h4>
<b>on_plusButton_clicked</b>(<i></i>)
@@ -493,6 +539,21 @@
previous current item
</dd>
</dl>
+<a NAME="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled" ID="MqttConnectionProfilesDialog.on_samePropertiesCheckBox_toggled"></a>
+<h4>MqttConnectionProfilesDialog.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="MqttConnectionProfilesDialog.on_showPasswordButton_toggled" ID="MqttConnectionProfilesDialog.on_showPasswordButton_toggled"></a>
<h4>MqttConnectionProfilesDialog.on_showPasswordButton_toggled</h4>
<b>on_showPasswordButton_toggled</b>(<i>checked</i>)
@@ -622,6 +683,13 @@
file path
</dd>
</dl>
+<a NAME="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked" ID="MqttConnectionProfilesDialog.on_willPropertiesButton_clicked"></a>
+<h4>MqttConnectionProfilesDialog.on_willPropertiesButton_clicked</h4>
+<b>on_willPropertiesButton_clicked</b>(<i></i>)
+
+<p>
+ Private slot to edit the last will user properties.
+</p>
<a NAME="MqttConnectionProfilesDialog.reject" ID="MqttConnectionProfilesDialog.reject"></a>
<h4>MqttConnectionProfilesDialog.reject</h4>
<b>reject</b>(<i></i>)
