--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Thu May 28 17:36:58 2020 +0200 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Tue Jun 23 19:26:33 2020 +0200 @@ -18,103 +18,134 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<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 /> +<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> -</tr><tr> +</tr> +<tr> <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> <td>Private method to populate the dialog.</td> -</tr><tr> +</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> +</tr> +<tr> <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> <td>Public method get the entered connection options.</td> -</tr><tr> +</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> +</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> +</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> +</tr> +<tr> <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> <td>Private slot to generate a client ID.</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>client, options=None, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>client</i> (MqttClient)</dt> <dd> reference to the MQTT client object -</dd><dt><i>options</i> (dict)</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", "TlsEnable", "TlsCaCert", "ConnectionTimeout". -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> +</dl> +<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><p> +</p> +<p> If no options dictionary is given, the dialog will be populated with default values. -</p><dl> +</p> +<dl> + <dt><i>options</i> (dict)</dt> <dd> dictionary containing the connection options to populate @@ -123,17 +154,22 @@ "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", "ConnectionTimeout". </dd> -</dl><a NAME="MqttConnectionOptionsDialog.__updateOkButton" ID="MqttConnectionOptionsDialog.__updateOkButton"></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> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary containing the connection options. It has the keys @@ -141,44 +177,59 @@ "WillTopic", "WillMessage", "WillQos", "WillRetain", "TlsEnable", "TlsCaCert", "ConnectionTimeout". </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (int, dict) </dd> -</dl><a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> +</dl> +<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> +</p> +<dl> + <dt><i>button</i> (QAbstractButton)</dt> <dd> button that has been pressed </dd> -</dl><a NAME="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked" ID="MqttConnectionOptionsDialog.on_cleanSessionCheckBox_clicked"></a> +</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> +</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> +</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> +</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> +</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>) + <p> Private slot to generate a client ID. </p>