MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<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>
</tr>
<tr>
<td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td>
<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>
<tr>
<td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td>
<td>Public method get the entered connection options.</td>
</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>
<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>
<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>
<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>
<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>
<dd>
dictionary containing the connection options to
            populate the dialog with. It must have the keys "ClientId",
            "Protocol", "ConnectionTimeout", "Keepalive", "CleanSession",
            "Username", "Password", "WillTopic", "WillMessage", "WillQos",
            "WillRetain", "WillProperties", "TlsEnable", "TlsCaCert",
            "UserProperties".
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</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>
        If no options dictionary is given, the dialog will be populated with
        default values.
</p>

<dl>

<dt><i>options</i> (dict)</dt>
<dd>
dictionary containing the connection options to populate
            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>
<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>
dictionary containing the connection options. It has the keys
            "ClientId", "Protocol", "ConnectionTimeout", "Keepalive",
            "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
            "WillQos", "WillRetain", "WillProperties", "TlsEnable",
            "TlsCaCert", "UserProperties".
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</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>

<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>
<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>
<dd>
current state of the clean session selection
</dd>
</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>

<dt><i>clientId</i> (str)</dt>
<dd>
client ID
</dd>
</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>

<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>