--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.PluginExtensionIrc.html	Sun Apr 20 11:08:39 2025 +0200
@@ -0,0 +1,365 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Extension_Irc.PluginExtensionIrc</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Extension_Irc.PluginExtensionIrc</h1>
+<p>
+Module implementing a plug-in providing IRC communication capability.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>__header__</td></tr>
+<tr><td>error</td></tr>
+<tr><td>ircExtensionPluginObject</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IrcExtensionPlugin">IrcExtensionPlugin</a></td>
+<td>Class documentation goes here.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#createIrcPage">createIrcPage</a></td>
+<td>Function to create the IRC configuration page.</td>
+</tr>
+<tr>
+<td><a href="#getConfigData">getConfigData</a></td>
+<td>Function returning data as required by the configuration dialog.</td>
+</tr>
+<tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Function to prepare for an un-installation.</td>
+</tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="IrcExtensionPlugin" ID="IrcExtensionPlugin"></a>
+<h2>IrcExtensionPlugin</h2>
+<p>
+    Class documentation goes here.
+</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="#IrcExtensionPlugin.__init__">IrcExtensionPlugin</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.__activateWidget">__activateWidget</a></td>
+<td>Private slot to handle the activation of the MQTT Monitor.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.__getIconPaths">__getIconPaths</a></td>
+<td>Private method to generate a list of paths to check for the requested icon name.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.__initialize">__initialize</a></td>
+<td>Private slot to (re)initialize the plugin.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.getIcon">getIcon</a></td>
+<td>Public method to get a named icon.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.getPixmap">getPixmap</a></td>
+<td>Public method to get a named pixmap.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings values.</td>
+</tr>
+<tr>
+<td><a href="#IrcExtensionPlugin.setPreferences">setPreferences</a></td>
+<td>Public method to store the various settings values.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="IrcExtensionPlugin.__init__" ID="IrcExtensionPlugin.__init__"></a>
+<h4>IrcExtensionPlugin (Constructor)</h4>
+<b>IrcExtensionPlugin</b>(<i>ui</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.__activateWidget" ID="IrcExtensionPlugin.__activateWidget"></a>
+<h4>IrcExtensionPlugin.__activateWidget</h4>
+<b>__activateWidget</b>(<i></i>)
+<p>
+        Private slot to handle the activation of the MQTT Monitor.
+</p>
+
+<a NAME="IrcExtensionPlugin.__getIconPaths" ID="IrcExtensionPlugin.__getIconPaths"></a>
+<h4>IrcExtensionPlugin.__getIconPaths</h4>
+<b>__getIconPaths</b>(<i>iconName</i>)
+<p>
+        Private method to generate a list of paths to check for the requested icon name.
+</p>
+
+<dl>
+
+<dt><i>iconName</i> (str)</dt>
+<dd>
+name of the icon
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of icon path names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.__initialize" ID="IrcExtensionPlugin.__initialize"></a>
+<h4>IrcExtensionPlugin.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+<p>
+        Private slot to (re)initialize the plugin.
+</p>
+
+<a NAME="IrcExtensionPlugin.__loadTranslator" ID="IrcExtensionPlugin.__loadTranslator"></a>
+<h4>IrcExtensionPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+        Private method to load the translation file.
+</p>
+
+<a NAME="IrcExtensionPlugin.activate" ID="IrcExtensionPlugin.activate"></a>
+<h4>IrcExtensionPlugin.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+        Public method to activate this plug-in.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.deactivate" ID="IrcExtensionPlugin.deactivate"></a>
+<h4>IrcExtensionPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+        Public method to deactivate this plug-in.
+</p>
+
+<a NAME="IrcExtensionPlugin.getIcon" ID="IrcExtensionPlugin.getIcon"></a>
+<h4>IrcExtensionPlugin.getIcon</h4>
+<b>getIcon</b>(<i>iconName</i>)
+<p>
+        Public method to get a named icon.
+</p>
+
+<dl>
+
+<dt><i>iconName</i> (str)</dt>
+<dd>
+name of the icon
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+requested icon
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QIcon
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.getPixmap" ID="IrcExtensionPlugin.getPixmap"></a>
+<h4>IrcExtensionPlugin.getPixmap</h4>
+<b>getPixmap</b>(<i>pixmapName</i>)
+<p>
+        Public method to get a named pixmap.
+</p>
+
+<dl>
+
+<dt><i>pixmapName</i> (str)</dt>
+<dd>
+name of the pixmap
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+requested pixmap
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QPixmap
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.getPreferences" ID="IrcExtensionPlugin.getPreferences"></a>
+<h4>IrcExtensionPlugin.getPreferences</h4>
+<b>getPreferences</b>(<i>key</i>)
+<p>
+        Public method to retrieve the various settings values.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the value to get
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the requested setting value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
+<a NAME="IrcExtensionPlugin.setPreferences" ID="IrcExtensionPlugin.setPreferences"></a>
+<h4>IrcExtensionPlugin.setPreferences</h4>
+<b>setPreferences</b>(<i>key, value</i>)
+<p>
+        Public method to store the various settings values.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the setting to be set
+</dd>
+<dt><i>value</i> (Any)</dt>
+<dd>
+the value to be set
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="createIrcPage" ID="createIrcPage"></a>
+<h2>createIrcPage</h2>
+<b>createIrcPage</b>(<i>configDlg</i>)
+<p>
+    Function to create the IRC configuration page.
+</p>
+
+<dl>
+
+<dt><i>configDlg</i> (ConfigurationWidget)</dt>
+<dd>
+reference to the configuration dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the configuration page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+TranslatorPage
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getConfigData" ID="getConfigData"></a>
+<h2>getConfigData</h2>
+<b>getConfigData</b>(<i></i>)
+<p>
+    Function returning data as required by the configuration dialog.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the relevant data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+<p>
+    Function to prepare for an un-installation.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>