--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Dec 23 19:45:41 2023 +0100
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sat Jan 06 13:10:46 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1>
-
<p>
Module implementing a dialog to enter MQTT connection options.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td>
<td>Class implementing a dialog to enter MQTT connection options.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a>
<h2>MqttConnectionOptionsDialog</h2>
-
<p>
Class implementing a dialog to enter MQTT connection options.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_MqttConnectionOptionsDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td>
<td>Constructor</td>
@@ -103,19 +100,20 @@
<td>Private slot to edit the last will user properties.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a>
<h4>MqttConnectionOptionsDialog (Constructor)</h4>
<b>MqttConnectionOptionsDialog</b>(<i>options=None, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>options</i> (dict)</dt>
@@ -135,7 +133,6 @@
<a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a>
<h4>MqttConnectionOptionsDialog.__populateDefaults</h4>
<b>__populateDefaults</b>(<i>options=None</i>)
-
<p>
Private method to populate the dialog.
</p>
@@ -143,6 +140,7 @@
If no options dictionary is given, the dialog will be populated with
default values.
</p>
+
<dl>
<dt><i>options</i> (dict)</dt>
@@ -157,10 +155,10 @@
<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>
@@ -171,17 +169,17 @@
<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>
Public method get the entered connection options.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -201,10 +199,10 @@
<a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a>
<h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot to handle the press of a button box button.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -215,10 +213,10 @@
<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>
@@ -229,10 +227,10 @@
<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>
@@ -243,17 +241,17 @@
<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>)
-
<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>
@@ -264,10 +262,10 @@
<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>
@@ -279,10 +277,10 @@
<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
+</body></html>
