diff -r 90d3ebed4cc0 -r e0175cb7c5d5 MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</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.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_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>
+<dt><i>client</i> (MqttClient)</dt>
+<dd>
+reference to the MQTT client object
+</dd><dt><i>options</i></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".
+@type dict
+</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", "Keepalive",
+ "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
+ "WillQos", "WillRetain".
+</dd>
+</dl><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>Returns:</dt>
+<dd>
+dictionary containing the connection options. It has the keys
+ "ClientId", "Keepalive", "CleanSession", "Username", "Password",
+ "WillTopic", "WillMessage", "WillQos", "WillRetain".
+</dd>
+</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>
+<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_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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
