Mercurial Repositories > MQTT Monitor / file comparison
comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html
- changeset 12
- e0175cb7c5d5
- child 37
- 8bc357057af3
equal
deleted
inserted
replaced
| 11:90d3ebed4cc0 | 12:e0175cb7c5d5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to enter MQTT connection options. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td> | |
| 34 <td>Class implementing a dialog to enter MQTT connection options.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a> | |
| 43 <h2>MqttConnectionOptionsDialog</h2> | |
| 44 <p> | |
| 45 Class implementing a dialog to enter MQTT connection options. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QDialog, Ui_MqttConnectionOptionsDialog | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td> | |
| 64 <td>Private method to populate the dialog.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td> | |
| 67 <td>Public method get the entered connection options.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 70 <td>Private slot to handle the press of a button box button.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td> | |
| 73 <td>Private slot to generate a client ID.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <h3>Static Methods</h3> | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 <a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a> | |
| 81 <h4>MqttConnectionOptionsDialog (Constructor)</h4> | |
| 82 <b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>) | |
| 83 <p> | |
| 84 Constructor | |
| 85 </p><dl> | |
| 86 <dt><i>client</i> (MqttClient)</dt> | |
| 87 <dd> | |
| 88 reference to the MQTT client object | |
| 89 </dd><dt><i>options</i></dt> | |
| 90 <dd> | |
| 91 dictionary containing the connection options to | |
| 92 populate the dialog with. It must have the keys "ClientId", | |
| 93 "Keepalive", "CleanSession", "Username", "Password", "WillTopic", | |
| 94 "WillMessage", "WillQos", "WillRetain". | |
| 95 @type dict | |
| 96 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 97 <dd> | |
| 98 reference to the parent widget | |
| 99 </dd> | |
| 100 </dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a> | |
| 101 <h4>MqttConnectionOptionsDialog.__populateDefaults</h4> | |
| 102 <b>__populateDefaults</b>(<i>options=None</i>) | |
| 103 <p> | |
| 104 Private method to populate the dialog. | |
| 105 </p><p> | |
| 106 If no options dictionary is given, the dialog will be populated with | |
| 107 default values. | |
| 108 </p><dl> | |
| 109 <dt><i>options</i> (dict)</dt> | |
| 110 <dd> | |
| 111 dictionary containing the connection options to populate | |
| 112 the dialog with. It must have the keys "ClientId", "Keepalive", | |
| 113 "CleanSession", "Username", "Password", "WillTopic", "WillMessage", | |
| 114 "WillQos", "WillRetain". | |
| 115 </dd> | |
| 116 </dl><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a> | |
| 117 <h4>MqttConnectionOptionsDialog.getConnectionOptions</h4> | |
| 118 <b>getConnectionOptions</b>(<i></i>) | |
| 119 <p> | |
| 120 Public method get the entered connection options. | |
| 121 </p><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 dictionary containing the connection options. It has the keys | |
| 125 "ClientId", "Keepalive", "CleanSession", "Username", "Password", | |
| 126 "WillTopic", "WillMessage", "WillQos", "WillRetain". | |
| 127 </dd> | |
| 128 </dl><dl> | |
| 129 <dt>Return Type:</dt> | |
| 130 <dd> | |
| 131 tuple of (int, dict) | |
| 132 </dd> | |
| 133 </dl><a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a> | |
| 134 <h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4> | |
| 135 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 136 <p> | |
| 137 Private slot to handle the press of a button box button. | |
| 138 </p><dl> | |
| 139 <dt><i>button</i> (QAbstractButton)</dt> | |
| 140 <dd> | |
| 141 button that has been pressed | |
| 142 </dd> | |
| 143 </dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a> | |
| 144 <h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4> | |
| 145 <b>on_generateIdButton_clicked</b>(<i></i>) | |
| 146 <p> | |
| 147 Private slot to generate a client ID. | |
| 148 </p> | |
| 149 <div align="right"><a href="#top">Up</a></div> | |
| 150 <hr /> | |
| 151 </body></html> |
