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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10428
a071d4065202
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Network.IRC.IrcUtilities</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Network.IRC.IrcUtilities</h1>
10
11 <p>
12 Module implementing functions used by several IRC objects.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>__ColorRe</td></tr><tr><td>__UrlRe</td></tr><tr><td>__channelModesDict</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22 <tr><td>None</td></tr>
23 </table>
24 <h3>Functions</h3>
25
26 <table>
27
28 <tr>
29 <td><a href="#__initChannelModesDict">__initChannelModesDict</a></td>
30 <td>Private module function to initialize the channels modes dictionary.</td>
31 </tr>
32 <tr>
33 <td><a href="#getChannelModesDict">getChannelModesDict</a></td>
34 <td>Module function to get the dictionary with the channel modes mappings.</td>
35 </tr>
36 <tr>
37 <td><a href="#ircFilter">ircFilter</a></td>
38 <td>Module method to make the message HTML compliant and detect URLs.</td>
39 </tr>
40 <tr>
41 <td><a href="#ircTimestamp">ircTimestamp</a></td>
42 <td>Module method to generate a time stamp string.</td>
43 </tr>
44 </table>
45 <hr />
46 <hr />
47 <a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a>
48 <h2>__initChannelModesDict</h2>
49 <b>__initChannelModesDict</b>(<i></i>)
50
51 <p>
52 Private module function to initialize the channels modes dictionary.
53 </p>
54 <div align="right"><a href="#top">Up</a></div>
55 <hr />
56 <hr />
57 <a NAME="getChannelModesDict" ID="getChannelModesDict"></a>
58 <h2>getChannelModesDict</h2>
59 <b>getChannelModesDict</b>(<i></i>)
60
61 <p>
62 Module function to get the dictionary with the channel modes mappings.
63 </p>
64 <dl>
65 <dt>Return:</dt>
66 <dd>
67 dictionary with channel modes mapping (dict)
68 </dd>
69 </dl>
70 <div align="right"><a href="#top">Up</a></div>
71 <hr />
72 <hr />
73 <a NAME="ircFilter" ID="ircFilter"></a>
74 <h2>ircFilter</h2>
75 <b>ircFilter</b>(<i>msg</i>)
76
77 <p>
78 Module method to make the message HTML compliant and detect URLs.
79 </p>
80 <dl>
81
82 <dt><i>msg</i></dt>
83 <dd>
84 message to process (string)
85 </dd>
86 </dl>
87 <dl>
88 <dt>Return:</dt>
89 <dd>
90 processed message (string)
91 </dd>
92 </dl>
93 <div align="right"><a href="#top">Up</a></div>
94 <hr />
95 <hr />
96 <a NAME="ircTimestamp" ID="ircTimestamp"></a>
97 <h2>ircTimestamp</h2>
98 <b>ircTimestamp</b>(<i></i>)
99
100 <p>
101 Module method to generate a time stamp string.
102 </p>
103 <dl>
104 <dt>Return:</dt>
105 <dd>
106 time stamp (string)
107 </dd>
108 </dl>
109 <div align="right"><a href="#top">Up</a></div>
110 <hr />
111 </body></html>

eric ide

mercurial