--- a/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html Sat Dec 23 19:45:41 2023 +0100 +++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html Sat Jan 06 13:10:46 2024 +0100 @@ -7,28 +7,38 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1> - <p> Module implementing the MQTT Monitor plug-in. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>mqttPluginObject</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +<tr><td>_Side</td></tr> +<tr><td>author</td></tr> +<tr><td>autoactivate</td></tr> +<tr><td>className</td></tr> +<tr><td>deactivateable</td></tr> +<tr><td>error</td></tr> +<tr><td>longDescription</td></tr> +<tr><td>mqttPluginObject</td></tr> +<tr><td>name</td></tr> +<tr><td>needsRestart</td></tr> +<tr><td>packageName</td></tr> +<tr><td>pyqtApi</td></tr> +<tr><td>shortDescription</td></tr> +<tr><td>version</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td> <td>Class implementing the MQTT Monitor plug-in.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#createMqttPage">createMqttPage</a></td> <td>Module function to create the autocompletion configuration page.</td> @@ -50,30 +60,29 @@ <td>Module function to prepare for an uninstallation.</td> </tr> </table> + <hr /> <hr /> <a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a> <h2>MqttMonitorPlugin</h2> - <p> Class implementing the MQTT Monitor plug-in. </p> + <h3>Derived from</h3> QObject <h3>Class Attributes</h3> - <table> <tr><td>PreferencesKey</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td> <td>Constructor</td> @@ -107,19 +116,20 @@ <td>Public method to store the various settings.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a> <h4>MqttMonitorPlugin (Constructor)</h4> <b>MqttMonitorPlugin</b>(<i>ui</i>) - <p> Constructor </p> + <dl> <dt><i>ui</i> (UI.UserInterface)</dt> @@ -130,31 +140,31 @@ <a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a> <h4>MqttMonitorPlugin.__activateWidget</h4> <b>__activateWidget</b>(<i></i>) - <p> Private slot to handle the activation of the MQTT Monitor. </p> + <a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a> <h4>MqttMonitorPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) - <p> Private slot to (re)initialize the plugin. </p> + <a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a> <h4>MqttMonitorPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) - <p> Private method to load the translation file. </p> + <a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a> <h4>MqttMonitorPlugin.activate</h4> <b>activate</b>(<i></i>) - <p> Public method to activate this plug-in. </p> + <dl> <dt>Return:</dt> <dd> @@ -170,17 +180,17 @@ <a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a> <h4>MqttMonitorPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) - <p> Public method to deactivate this plug-in. </p> + <a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a> <h4>MqttMonitorPlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) - <p> Public method to retrieve the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -203,10 +213,10 @@ <a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a> <h4>MqttMonitorPlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) - <p> Public method to store the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -224,10 +234,10 @@ <a NAME="createMqttPage" ID="createMqttPage"></a> <h2>createMqttPage</h2> <b>createMqttPage</b>(<i>configDlg, </i>) - <p> Module function to create the autocompletion configuration page. </p> + <dl> <dt><i>configDlg</i> (ConfigurationWidget)</dt> @@ -253,10 +263,10 @@ <a NAME="exeDisplayData" ID="exeDisplayData"></a> <h2>exeDisplayData</h2> <b>exeDisplayData</b>(<i></i>) - <p> Module function to support the display of some executable info. </p> + <dl> <dt>Return:</dt> <dd> @@ -276,10 +286,10 @@ <a NAME="getConfigData" ID="getConfigData"></a> <h2>getConfigData</h2> <b>getConfigData</b>(<i></i>) - <p> Module function returning data as required by the configuration dialog. </p> + <dl> <dt>Return:</dt> <dd> @@ -298,10 +308,10 @@ <a NAME="installDependencies" ID="installDependencies"></a> <h2>installDependencies</h2> <b>installDependencies</b>(<i>pipInstall</i>) - <p> Function to install dependencies of this plug-in. </p> + <dl> <dt><i>pipInstall</i> (function)</dt> @@ -315,10 +325,10 @@ <a NAME="prepareUninstall" ID="prepareUninstall"></a> <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>) - <p> Module function to prepare for an uninstallation. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>