--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.html Sat Dec 23 19:45:41 2023 +0100
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionProfilesDialog.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.MqttConnectionProfilesDialog</h1>
-
<p>
Module implementing a dialog to edit the MQTT connection profiles.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MqttConnectionProfilesDialog">MqttConnectionProfilesDialog</a></td>
<td>Class implementing a dialog to edit the MQTT connection profiles.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MqttConnectionProfilesDialog" ID="MqttConnectionProfilesDialog"></a>
<h2>MqttConnectionProfilesDialog</h2>
-
<p>
Class implementing a dialog to edit the MQTT connection profiles.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_MqttConnectionProfilesDialog
<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="#MqttConnectionProfilesDialog.__init__">MqttConnectionProfilesDialog</a></td>
<td>Constructor</td>
@@ -199,19 +196,20 @@
<td>Public slot to reject the dialog changes.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MqttConnectionProfilesDialog.__init__" ID="MqttConnectionProfilesDialog.__init__"></a>
<h4>MqttConnectionProfilesDialog (Constructor)</h4>
<b>MqttConnectionProfilesDialog</b>(<i>profiles, currentProfile="", parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>profiles</i> (dict)</dt>
@@ -236,10 +234,10 @@
<a NAME="MqttConnectionProfilesDialog.__applyProfile" ID="MqttConnectionProfilesDialog.__applyProfile"></a>
<h4>MqttConnectionProfilesDialog.__applyProfile</h4>
<b>__applyProfile</b>(<i></i>)
-
<p>
Private method to apply the entered data to the list of profiles.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -255,17 +253,17 @@
<a NAME="MqttConnectionProfilesDialog.__clearProfile" ID="MqttConnectionProfilesDialog.__clearProfile"></a>
<h4>MqttConnectionProfilesDialog.__clearProfile</h4>
<b>__clearProfile</b>(<i></i>)
-
<p>
Private method to clear the profile data entry fields.
</p>
+
<a NAME="MqttConnectionProfilesDialog.__defaultProfile" ID="MqttConnectionProfilesDialog.__defaultProfile"></a>
<h4>MqttConnectionProfilesDialog.__defaultProfile</h4>
<b>__defaultProfile</b>(<i></i>)
-
<p>
Private method to populate non-existing profile items.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -281,11 +279,11 @@
<a NAME="MqttConnectionProfilesDialog.__isChangedProfile" ID="MqttConnectionProfilesDialog.__isChangedProfile"></a>
<h4>MqttConnectionProfilesDialog.__isChangedProfile</h4>
<b>__isChangedProfile</b>(<i></i>)
-
<p>
Private method to check, if the currently shown profile contains some
changed data.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -301,10 +299,10 @@
<a NAME="MqttConnectionProfilesDialog.__populateProfile" ID="MqttConnectionProfilesDialog.__populateProfile"></a>
<h4>MqttConnectionProfilesDialog.__populateProfile</h4>
<b>__populateProfile</b>(<i>profileName</i>)
-
<p>
Private method to populate the profile data entry fields.
</p>
+
<dl>
<dt><i>profileName</i> (str)</dt>
@@ -315,18 +313,18 @@
<a NAME="MqttConnectionProfilesDialog.__populateProfileDefault" ID="MqttConnectionProfilesDialog.__populateProfileDefault"></a>
<h4>MqttConnectionProfilesDialog.__populateProfileDefault</h4>
<b>__populateProfileDefault</b>(<i></i>)
-
<p>
Private method to populate the profile data entry fields with default
profile values.
</p>
+
<a NAME="MqttConnectionProfilesDialog.__populateProfilesList" ID="MqttConnectionProfilesDialog.__populateProfilesList"></a>
<h4>MqttConnectionProfilesDialog.__populateProfilesList</h4>
<b>__populateProfilesList</b>(<i>currentProfile=""</i>)
-
<p>
Private method to populate the list of defined profiles.
</p>
+
<dl>
<dt><i>currentProfile</i> (str)</dt>
@@ -337,10 +335,10 @@
<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>
@@ -351,32 +349,32 @@
<a NAME="MqttConnectionProfilesDialog.__resetProfile" ID="MqttConnectionProfilesDialog.__resetProfile"></a>
<h4>MqttConnectionProfilesDialog.__resetProfile</h4>
<b>__resetProfile</b>(<i></i>)
-
<p>
Private method to reset the profile data entry fields to their stored
values.
</p>
+
<a NAME="MqttConnectionProfilesDialog.__updateApplyButton" ID="MqttConnectionProfilesDialog.__updateApplyButton"></a>
<h4>MqttConnectionProfilesDialog.__updateApplyButton</h4>
<b>__updateApplyButton</b>(<i></i>)
-
<p>
Private method to set the state of the Apply button.
</p>
+
<a NAME="MqttConnectionProfilesDialog.accept" ID="MqttConnectionProfilesDialog.accept"></a>
<h4>MqttConnectionProfilesDialog.accept</h4>
<b>accept</b>(<i></i>)
-
<p>
Public slot to accept the dialog.
</p>
+
<a NAME="MqttConnectionProfilesDialog.getProfiles" ID="MqttConnectionProfilesDialog.getProfiles"></a>
<h4>MqttConnectionProfilesDialog.getProfiles</h4>
<b>getProfiles</b>(<i></i>)
-
<p>
Public method to return a dictionary of profiles.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -398,10 +396,10 @@
<a NAME="MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged" ID="MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_brokerAddressEdit_textChanged</h4>
<b>on_brokerAddressEdit_textChanged</b>(<i>address</i>)
-
<p>
Private slot handling a change of the broker address.
</p>
+
<dl>
<dt><i>address</i> (str)</dt>
@@ -412,10 +410,10 @@
<a NAME="MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionProfilesDialog.on_cleanSessionCheckBox_clicked"></a>
<h4>MqttConnectionProfilesDialog.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>
@@ -426,10 +424,10 @@
<a NAME="MqttConnectionProfilesDialog.on_clientIdEdit_textChanged" ID="MqttConnectionProfilesDialog.on_clientIdEdit_textChanged"></a>
<h4>MqttConnectionProfilesDialog.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>
@@ -440,31 +438,31 @@
<a NAME="MqttConnectionProfilesDialog.on_copyButton_clicked" ID="MqttConnectionProfilesDialog.on_copyButton_clicked"></a>
<h4>MqttConnectionProfilesDialog.on_copyButton_clicked</h4>
<b>on_copyButton_clicked</b>(<i></i>)
-
<p>
Private slot to copy the selected profile entry.
</p>
+
<a NAME="MqttConnectionProfilesDialog.on_generateIdButton_clicked" ID="MqttConnectionProfilesDialog.on_generateIdButton_clicked"></a>
<h4>MqttConnectionProfilesDialog.on_generateIdButton_clicked</h4>
<b>on_generateIdButton_clicked</b>(<i></i>)
-
<p>
Private slot to generate a client ID.
</p>
+
<a NAME="MqttConnectionProfilesDialog.on_minusButton_clicked" ID="MqttConnectionProfilesDialog.on_minusButton_clicked"></a>
<h4>MqttConnectionProfilesDialog.on_minusButton_clicked</h4>
<b>on_minusButton_clicked</b>(<i></i>)
-
<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>
@@ -475,17 +473,17 @@
<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>)
-
<p>
Private slot to add a new empty profile entry.
</p>
+
<a NAME="MqttConnectionProfilesDialog.on_profileButtonBox_clicked" ID="MqttConnectionProfilesDialog.on_profileButtonBox_clicked"></a>
<h4>MqttConnectionProfilesDialog.on_profileButtonBox_clicked</h4>
<b>on_profileButtonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot handling presses of the profile buttons.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -496,10 +494,10 @@
<a NAME="MqttConnectionProfilesDialog.on_profileEdit_textChanged" ID="MqttConnectionProfilesDialog.on_profileEdit_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_profileEdit_textChanged</h4>
<b>on_profileEdit_textChanged</b>(<i>name</i>)
-
<p>
Private slot to handle changes of the profile name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -510,10 +508,10 @@
<a NAME="MqttConnectionProfilesDialog.on_profilesList_currentItemChanged" ID="MqttConnectionProfilesDialog.on_profilesList_currentItemChanged"></a>
<h4>MqttConnectionProfilesDialog.on_profilesList_currentItemChanged</h4>
<b>on_profilesList_currentItemChanged</b>(<i>current, previous</i>)
-
<p>
Private slot to handle a change of the current profile.
</p>
+
<dl>
<dt><i>current</i> (QListWidgetItem)</dt>
@@ -528,10 +526,10 @@
<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>
@@ -543,10 +541,10 @@
<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>)
-
<p>
Private slot to show or hide the password.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -557,11 +555,11 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled"></a>
<h4>MqttConnectionProfilesDialog.on_tlsCertsFileButton_toggled</h4>
<b>on_tlsCertsFileButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the selection of using a non-default
certificates file.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -572,10 +570,10 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_tlsCertsFilePicker_textChanged</h4>
<b>on_tlsCertsFilePicker_textChanged</b>(<i>path</i>)
-
<p>
Private slot handling a change of the TLS CA certificates file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -586,11 +584,11 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled"></a>
<h4>MqttConnectionProfilesDialog.on_tlsDefaultCertsButton_toggled</h4>
<b>on_tlsDefaultCertsButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the selection of using the default
certificates file.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -601,10 +599,10 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsGroupBox_toggled" ID="MqttConnectionProfilesDialog.on_tlsGroupBox_toggled"></a>
<h4>MqttConnectionProfilesDialog.on_tlsGroupBox_toggled</h4>
<b>on_tlsGroupBox_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the selection of TLS mode.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -615,11 +613,11 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled"></a>
<h4>MqttConnectionProfilesDialog.on_tlsSelfSignedCertsButton_toggled</h4>
<b>on_tlsSelfSignedCertsButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the selection of using self signed
client certificate and key files.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -630,10 +628,10 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_tlsSelfSignedCertsFilePicker_textChanged</h4>
<b>on_tlsSelfSignedCertsFilePicker_textChanged</b>(<i>path</i>)
-
<p>
Private slot handling a change of the TLS CA certificates file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -644,10 +642,10 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_tlsSelfSignedClientCertFilePicker_textChanged</h4>
<b>on_tlsSelfSignedClientCertFilePicker_textChanged</b>(<i>path</i>)
-
<p>
Private slot handling a change of the TLS client certificate file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -658,10 +656,10 @@
<a NAME="MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged" ID="MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged"></a>
<h4>MqttConnectionProfilesDialog.on_tlsSelfSignedClientKeyFilePicker_textChanged</h4>
<b>on_tlsSelfSignedClientKeyFilePicker_textChanged</b>(<i>path</i>)
-
<p>
Private slot handling a change of the TLS client key file.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -672,17 +670,17 @@
<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>)
-
<p>
Public slot to reject the dialog changes.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
