src/eric7/Documentation/Source/eric7.Network.IRC.IrcUtilities.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Network.IRC.IrcUtilities.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Network.IRC.IrcUtilities</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Network.IRC.IrcUtilities</h1>
+
+<p>
+Module implementing functions used by several IRC objects.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>__ColorRe</td></tr><tr><td>__UrlRe</td></tr><tr><td>__channelModesDict</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#__initChannelModesDict">__initChannelModesDict</a></td>
+<td>Private module function to initialize the channels modes dictionary.</td>
+</tr>
+<tr>
+<td><a href="#getChannelModesDict">getChannelModesDict</a></td>
+<td>Module function to get the dictionary with the channel modes mappings.</td>
+</tr>
+<tr>
+<td><a href="#ircFilter">ircFilter</a></td>
+<td>Module method to make the message HTML compliant and detect URLs.</td>
+</tr>
+<tr>
+<td><a href="#ircTimestamp">ircTimestamp</a></td>
+<td>Module method to generate a time stamp string.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a>
+<h2>__initChannelModesDict</h2>
+<b>__initChannelModesDict</b>(<i></i>)
+
+<p>
+    Private module function to initialize the channels modes dictionary.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getChannelModesDict" ID="getChannelModesDict"></a>
+<h2>getChannelModesDict</h2>
+<b>getChannelModesDict</b>(<i></i>)
+
+<p>
+    Module function to get the dictionary with the channel modes mappings.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary with channel modes mapping (dict)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="ircFilter" ID="ircFilter"></a>
+<h2>ircFilter</h2>
+<b>ircFilter</b>(<i>msg</i>)
+
+<p>
+    Module method to make the message HTML compliant and detect URLs.
+</p>
+<dl>
+
+<dt><i>msg</i></dt>
+<dd>
+message to process (string)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+processed message (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="ircTimestamp" ID="ircTimestamp"></a>
+<h2>ircTimestamp</h2>
+<b>ircTimestamp</b>(<i></i>)
+
+<p>
+    Module method to generate a time stamp string.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+time stamp (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial